Get Payout History

GET

/api/v1/merchants/payouts

Get payout history with pagination and filters.

Filters:

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

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

page: Page number (starts from 1)

size: Items per page (max 100)

Returns: Payouts to third parties (contractors, suppliers, etc.)

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Query Params

Header Params

🟢200OK

application/json

Successful Response

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{}

Modified at 2025-10-20 10:43:39