Mercury.Organization (mercury_client v1.0.0)

Copy Markdown View Source

The Mercury Organization API — the org tied to the API token, and partner onboarding.

Summary

Functions

Returns the organisation associated with the API token. GET /organisation

Submits pre-fill data for a new Mercury applicant (partner integration flows). data may be any JSON-serializable map. POST /onboarding

Functions

get(client)

@spec get(client :: Mercury.Client.t()) ::
  {:ok, Mercury.OrganizationInfo.t()} | {:error, Exception.t()}

Returns the organisation associated with the API token. GET /organisation

get!(client)

@spec get!(client :: Mercury.Client.t()) :: Mercury.OrganizationInfo.t()

submit_onboarding(client, data)

@spec submit_onboarding(client :: Mercury.Client.t(), data :: map()) ::
  :ok | {:error, Exception.t()}

Submits pre-fill data for a new Mercury applicant (partner integration flows). data may be any JSON-serializable map. POST /onboarding

submit_onboarding!(client, data)

@spec submit_onboarding!(client :: Mercury.Client.t(), data :: map()) :: :ok