List withdrawals
Merchant Balance
List withdrawals
List withdrawals for the authenticated merchant with optional status filtering and pagination
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, usePOST /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
Your merchant API key
Query Parameters
Number of results per page.Default:
50Page number to retrieve.Default:
1Filter by withdrawal status.Allowed values:
PENDING, SUBMITTED, SETTLED, FAILEDRequest Examples
Response
Withdrawal records matching the current filter.
Current page number.
Results per page.
Total number of withdrawals matching filters.
Total number of pages available.
Success Response
Error Responses
This endpoint may return:400: Invalid query parameters401: Unauthorized500: Internal server error
Next Steps
Get Withdrawal
Retrieve a single withdrawal by ID
Create Withdrawal
Initiate a new merchant balance withdrawal