logo
Merchant Withdrawals APIList merchant withdrawals

List merchant withdrawals

Returns paginated list of merchant withdrawals with optional status filter.

curl -X GET "https://api.example.com/v1/api/v1/withdrawals/?page=25&per_page=25&status=null&order=desc" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "data": [
    {
      "address": "TXqZ5nM3YwK8vR2pL7dFcJ6hG9bE4sA1uN",
      "amount": "150.00",
      "amount_to_receive": "149.00",
      "created_at": "2026-02-26T14:30:00+00:00",
      "external_tx_id": "a1b2c3d4e5f6...",
      "network_fee": "1.00",
      "processed_at": "2026-02-26T14:35:00+00:00",
      "status": "completed",
      "updated_at": "2026-02-26T14:35:00+00:00",
      "withdraw_uuid": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
      "withdrawal_method_id": 1
    }
  ],
  "page": 1,
  "per_page": 20,
  "successful": true,
  "total": 42,
  "total_pages": 3
}
GET
/api/v1/withdrawals/
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Merchant API Key.

Merchant API Key.
query
pageinteger

Page number

Min: 1
query
per_pageinteger

Items per page

Min: 1 • Max: 500
query
statusstring

Filter by withdrawal status

query
orderstring

Sort order by created_at

Options: desc, asc
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Merchant API Key.

Query Parameters

pageinteger

Page number

per_pageinteger

Items per page

statusstring

Filter by withdrawal status

orderstring

Sort order by created_at

Allowed values:descasc

Responses

successfulboolean

Whether the request was successful

pageinteger
Required

Current page number

per_pageinteger
Required

Items per page

totalinteger
Required

Total withdrawals matching the filter

total_pagesinteger
Required

Total pages

dataarray
Required