Payouts

Disburse funds to bank accounts, mobile wallets, and stablecoin addresses.

Authentication Collections Payouts Customers Balances Webhooks Products Disputes FX Rates

POST/v1/payouts

Create a new payout

Parameters

Name	Type	In	Required	Description
`amount`	`integer`	body	Required	Amount in smallest currency unit
`currency`	`string`	body	Required	ISO 4217 currency code
`destination`	`object`	body	Required	Payout destination (bank_account, mobile_wallet, or stablecoin)
`description`	`string`	body	Optional	Internal description
`idempotency_key`	`string`	header	Required	Unique key to prevent duplicates

Response Codes

201Payout created400Invalid parameters402Insufficient balance409Duplicate idempotency key

1{
2  "id": "pay_x1y2z3w4",
3  "object": "payout",
4  "amount": 250000,
5  "currency": "NGN",
6  "status": "processing",
7  "destination": {
8    "type": "bank_account",
9    "bank_code": "044",
10    "bank_name": "Access Bank",
11    "account_number": "****6789"
12  },
13  "estimated_arrival": "2026-05-02T09:00:00Z",
14  "created_at": "2026-05-01T15:00:00Z"
15}

GET/v1/payouts/{id}

Retrieve a payout by ID

Parameters

Name	Type	In	Required	Description
`id`	`string`	path	Required	Payout ID

Response Codes

200Payout retrieved404Payout not found

1{
2  "id": "pay_x1y2z3w4",
3  "object": "payout",
4  "amount": 250000,
5  "currency": "NGN",
6  "status": "completed",
7  "completed_at": "2026-05-02T08:45:00Z",
8  "created_at": "2026-05-01T15:00:00Z"
9}

GET/v1/payouts

List payouts with pagination

Parameters

Name	Type	In	Required	Description
`limit`	`integer`	query	Optional	Number of results (1-100)
`status`	`string`	query	Optional	Filter: processing, completed, failed, cancelled

Response Codes

200List of payouts

1{
2  "object": "list",
3  "data": [...],
4  "has_more": false
5}