Sumup.Payouts (Sumup v1.0.0)

Copy Markdown View Source

Payouts: a date-ranged report of funds settled to (or deducted from) a merchant's bank account. API version v1.0.

Unlike every other resource, this endpoint supports content negotiation between JSON and CSV via the format: option — list/3 returns {:ok, [Sumup.Payout.t()]} for format: :json (the default) and {:ok, csv_string} for format: :csv.

Summary

Functions

Fetches the payout report for a merchant over a date range.

Functions

list(config, merchant_code, opts)

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

Fetches the payout report for a merchant over a date range.

  • :start_date (String.t/0) - Required. ISO 8601 date, e.g. "2026-01-01".

  • :end_date (String.t/0) - Required. ISO 8601 date, e.g. "2026-01-31".

  • :format - Response format. The default value is :json.

  • :limit (pos_integer/0) - Max number of entries to return (1-9999).

  • :order - Sort direction by date. The default value is :asc.