Sumup.Customers (Sumup v1.0.0)

Copy Markdown View Source

Customers: a lightweight vault for storing payer identity and reusable payment instruments. API version v0.1.

Summary

Functions

create(config, params)

Creates a customer.

get(config, customer_id)

Retrieves a customer by id.

update(config, customer_id, params)

Updates a customer's personal details.

Functions

create(config, params)

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

Creates a customer.

  • :customer_id (String.t/0) - Required. Your own unique identifier for this customer.

  • :personal_details (map/0) - %{first_name:, last_name:, email:, phone:, birth_date:, tax_id:, address:}, all optional.

get(config, customer_id)

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

Retrieves a customer by id.

update(config, customer_id, params)

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

Updates a customer's personal details.

  • :customer_id (String.t/0) - Required. Your own unique identifier for this customer.

  • :personal_details (map/0) - %{first_name:, last_name:, email:, phone:, birth_date:, tax_id:, address:}, all optional.