Sumup.Merchants (Sumup v1.0.0)

Copy Markdown View Source

Merchants: legal entity and KYC profile data. API version v1.

This resource is read-only in SumUp's public API — see Sumup.Merchant's moduledoc for why there's no update/3 here.

Summary

Functions

Retrieves a merchant's profile. Pass version: "latest" to include pending (unconfirmed) changes and see a change_status; omit it to see only the last confirmed state.

Retrieves a single person associated with a merchant.

Lists the persons (owners/directors/controllers) associated with a merchant.

Functions

get(config, merchant_code, opts \\ [])

@spec get(Sumup.Config.t(), String.t(), keyword()) ::
  {:ok, Sumup.Merchant.t()} | {:error, Sumup.Error.t()}

Retrieves a merchant's profile. Pass version: "latest" to include pending (unconfirmed) changes and see a change_status; omit it to see only the last confirmed state.

get_person(config, merchant_code, person_id, opts \\ [])

@spec get_person(Sumup.Config.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Sumup.Error.t()}

Retrieves a single person associated with a merchant.

list_persons(config, merchant_code, opts \\ [])

@spec list_persons(Sumup.Config.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Sumup.Error.t()}

Lists the persons (owners/directors/controllers) associated with a merchant.