FinancialPayouts | SumUp Developer

Ordered list of payout and payout-deduction records.

Fields

idintegerrequired
format: int64
Unique identifier of the payout-related record.

Example: 123456789
typestringrequired
Options:"PAYOUT""CHARGE_BACK_DEDUCTION""REFUND_DEDUCTION""DD_RETURN_DEDUCTION""BALANCE_DEDUCTION"
High-level payout record category.

Example: "PAYOUT"
amountnumberrequired
format: float
Amount of the payout or deduction in major units.

Example: 132.45
datestringrequired
format: date
Payout date associated with the record, in YYYY-MM-DD format.

Example: "2024-02-29"
currencystringrequired
Three-letter ISO 4217 currency code of the payout.

Example: "EUR"
feenumberrequired
format: float
Fee amount associated with the payout record, in major units.

Example: 3.12
statusstringrequired
Options:"SUCCESSFUL""FAILED"
Merchant-facing outcome of the payout record.

Example: "SUCCESSFUL"
referencestringrequired
Processor or payout reference associated with the record.

Example: "payout-2024-02-29"
transaction_codestringrequired
Transaction code of the original sale associated with the payout or deduction.

Example: "TEENSK4W2K"