Skip to main content
GET
List withdrawals

Overview

Returns merchant withdrawal history for the authenticated merchant. Withdrawals draw from the withdrawal balance only — if the needed funds are still in the collection balance, use POST /v1/merchant/balance/transfer to move them first. Use this endpoint to track pending, submitted, settled, or failed withdrawals and to paginate through historical activity.

Authentication

string
required
Your merchant API key

Query Parameters

integer
Number of results per page.Default: 50
integer
Page number to retrieve.Default: 1
string
Filter by withdrawal status.Allowed values: PENDING, SUBMITTED, SETTLED, FAILED

Request Examples

Response

array
Withdrawal records matching the current filter.
integer
required
Current page number.
integer
required
Results per page.
integer
required
Total number of withdrawals matching filters.
integer
required
Total number of pages available.

Success Response

Error Responses

This endpoint may return:
  • 400: Invalid query parameters
  • 401: Unauthorized
  • 500: Internal server error

Next Steps

Get Withdrawal

Retrieve a single withdrawal by ID

Create Withdrawal

Initiate a new merchant balance withdrawal