SUsumup
Payouts

List payouts

Changed on

Lists payout and payout-deduction records for the specified merchant account within the requested date range.

The response can include:

  • regular payouts (type = PAYOUT)
  • deduction records for refunds, chargebacks, direct debit returns, or balance adjustments

Results are sorted by payout date in the requested order.

get/v1.0/merchants/{merchant_code}/payouts

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v1.0/merchants/{merchant_code}/payouts
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: user.profile, user.profile_readonly, payouts.read

Path parameters

merchant_codestring required
Example:MH4H92C7

Short unique identifier for the merchant.

Query parameters

start_datestring date required
Example:2024-02-01

Start date of the payout period filter, inclusive, in ISO8601 date format (YYYY-MM-DD).

end_datestring date required
Example:2024-02-29

End date of the payout period filter, inclusive, in ISO8601 date format (YYYY-MM-DD). Must be greater than or equal to start_date.

format'json' | 'csv'
Example:json

Response format for the payout list.

limitinteger
Example:10

Maximum number of payout records to return.

order'asc' | 'desc'
Example:desc

Sort direction for the returned payouts.

Response

Returns the list of payout and deduction records for the requested period.

idinteger required

Unique identifier of the payout-related record.

type'PAYOUT' | 'CHARGE_BACK_DEDUCTION' | 'REFUND_DEDUCTION' | 'DD_RETURN_DEDUCTION' | 'BALANCE_DEDUCTION' required

High-level payout record category.

amountnumber float required

Amount of the payout or deduction in major units.

datestring date required

Payout date associated with the record, in YYYY-MM-DD format.

currencystring required

Three-letter ISO 4217 currency code of the payout.

feenumber float required

Fee amount associated with the payout record, in major units.

status'SUCCESSFUL' | 'FAILED' required

Merchant-facing outcome of the payout record.

referencestring required

Processor or payout reference associated with the record.

transaction_codestring required

Transaction code of the original sale associated with the payout or deduction.

Example response

[
  {
    "id": 123456789,
    "type": "PAYOUT",
    "amount": 132.45,
    "date": "2024-02-29",
    "currency": "EUR",
    "fee": 3.12,
    "status": "SUCCESSFUL",
    "reference": "payout-2024-02-29",
    "transaction_code": "TEENSK4W2K"
  }
]

Changes

  • c75ca16e1e44Revision changes
    • info

      the security scope payouts.read was added to the endpoint's security scheme oauth2

  • b54086fdb4ccRevision changes
    • breaking

      for the query request parameter format, default value json was added

    • breaking

      for the query request parameter order, default value asc was added

    • warning

      for the query request parameter limit, the max was set to 9999.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the media type text/plain for the response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status