Skip to main content
GET
Legacy: List payouts

Overview

Retrieve a paginated list of read-only settlement payouts.
Payouts are legacy read-only settlement artifacts. Merchant-initiated sends use the Transfers API.

Authentication

X-Api-Key
string
required
Your merchant API key

Query Parameters

type
string
Filter by payout typeAllowed values: CRYPTO_PAYOUT, NGN_PAYOUT
status
string
Filter by payout statusAllowed values: PROCESSING, SETTLED, FAILED
limit
integer
Results per pageDefault: 20Max: 100
page
integer
Page number (1-indexed)Default: 1

Request Examples

Response

data
array
required
Array of payout objects
page
integer
required
Current page number
limit
integer
required
Results per page
total
integer
required
Total number of payouts matching filters
total_pages
integer
required
Total number of pages

Success Response

Next Steps

Get Payout

Get a specific payout by ID

List Deposits

View incoming deposits