Get Settlement Batches

GET

/api/v1/merchants/wallet/settlements

Get settlement batches with pagination and filters

Query Parameters:

currency_code (optional): Filter by currency (e.g., USD, EUR)

status (optional): Filter by status (pending, processing, completed, failed)

page: Page number (starts from 1, default: 1)

size: Number of batches per page (default: 50, max: 100)

Returns:
Batches ordered by created_at (newest first) with pagination metadata

Examples:

Get all batches: GET /api/v1/merchants/wallet/settlements

Get USD batches: GET /api/v1/merchants/wallet/settlements?currency_code=USD

Get completed batches: GET /api/v1/merchants/wallet/settlements?status=completed

Get page 2: GET /api/v1/merchants/wallet/settlements?page=2&size=20

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Header Params

🟢200OK

application/json

Successful Response

Bodyapplication/json

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/merchants/wallet/settlements?currency_code=ngn&status=undefined&page=1&size=10' \
--header 'x-api-key: <api-key>'

Response Example

200 - Example 1

{}

Modified at 2025-10-19 19:23:05