Payouts
Export Payouts
Download a date-filtered range of payouts as CSV (default) or JSON, for reconciliation.
GET
Query Params
Inclusive lower bound on
createdAt (ISO 8601). Optional.Inclusive upper bound on
createdAt (ISO 8601). Optional.Output format:
csv (default) or json.endDate is a timestamp, not a calendar day: 2024-01-31 resolves to 2024-01-31T00:00:00Z and excludes that day — to include the full day, pass 2024-01-31T23:59:59Z. When both dates are provided, startDate must be before or equal to endDate, otherwise the API responds with 400 Bad Request.Response
The response is a file download (Content-Disposition: attachment; filename="payouts_<startDate>_<endDate>.<format>") and is streamed, so it stays memory-efficient over large date ranges.
format=csv (default) → Content-Type: text/csv. The first line is the header row, then one row per payout. Values are RFC 4180-escaped. Columns, in order:
| Column | Description |
|---|---|
id | Payout identifier. |
externalId | Your external reference, if any. |
state | Current payout state. |
onBehalfOf | End user/entity the payout was made for. |
amount | Payout amount. |
developerFee | Developer fee applied, if any. |
currency | Payout currency. |
destinationType | Destination type (e.g. bank, crypto_wallet, qr_code). |
errorReason | Failure reason, if the payout failed. |
partnerName | Settlement partner name. |
partnerTransactionId | Partner-side transaction id. |
partnerStatus | Partner-side status. |
createdAt | ISO 8601 creation timestamp. |
updatedAt | ISO 8601 last-update timestamp. |
format=json → Content-Type: application/json. An envelope with the rows in data and the number of records emitted in count.