Money
List payouts
The cash couriers handed over, newest first.
Query parameters
- limitinteger
How many objects to return, 1–100. Default 25.
1–100
- cursorstring
The
next_cursorfrom the previous page. Repeat the same filters with it.up to 512 characters
Returns
200 OK · A page of payouts. PayoutList
- objectstringRequired
always "list"
- has_morebooleanRequired
- next_cursorstring or nullRequired
Pass as
cursorto get the next page.nullon the last page. - dataarray of PayoutsRequired
12 child fields
- idstring
starts with pay_
- objectstring
always "payout"
- courierstring or null
- referencestring or null
- payout_datestring
date
- amount_receivedMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- expectedMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- differenceMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- orders_countinteger
- notesstring or null
- created_atstring
ISO 8601 date-time, UTC
- livemodeboolean
Errors
Every error has the same shape. This endpoint can answer with:
