v9
OpenAPI 3.1.02026-08-043703845.2 MBWithdrawals
List withdrawals
Returns a paginated list of withdrawals for a company, with optional sorting and date filtering.
Required permissions:
- payout:withdrawal:read
get/withdrawals
Query parameters
afterstring nullable
Returns the elements in the list that come after the specified cursor.
beforestring nullable
Returns the elements in the list that come before the specified cursor.
firstinteger nullable
Returns the first n elements from the list.
Example:42
lastinteger nullable
Returns the last n elements from the list.
Example:42
company_idstring required
The unique identifier of the company to list withdrawals for.
Example:biz_xxxxxxxxxxxxxx
direction'asc' | 'desc'
The direction of the sort.
created_beforestring date-time nullable
Only return withdrawals created before this timestamp.
Example:2023-12-01T05:00:00.401Z
created_afterstring date-time nullable
Only return withdrawals created after this timestamp.
Example:2023-12-01T05:00:00.401Z
Response
A successful response
Example response
{
"data": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"fee_amount": 6.9,
"id": "wdrl_xxxxxxxxxxxxx",
"markup_fee": 6.9,
"payout_request_id": "cofr_xxxxxxxxxxxxxx"
}
]
}