Skip to main content
POST
Executes an outbound bank transfer or international payout. Supports idempotency via the Idempotency-Key header.

Scopes required

payouts:write or *

Headers

string
required
Bearer API secret key formatted as Bearer sk_live_... or Bearer sk_test_....
string
Unique UUID v4 string to prevent duplicate transfers during network retries.

Body

number
Amount in major currency units for same-currency payouts (e.g. 25000 for 25,000 NGN).
string
Source wallet currency debited (e.g. NGN, USD). Defaults to NGN.
string
Destination currency received by the beneficiary (e.g. NGN, USD). Defaults to sourceCurrency.
string
required
Full legal name of the beneficiary.
string
3-digit CBN bank code (for Nigerian NIP payouts).
string
10-digit NUBAN account number (for Nigerian NIP payouts).
string
Recipient physical address (required for international wires).
string
9-digit ABA routing number (for US ACH/Wire payouts).
string
International Bank Account Number (for EUR SEPA payouts).
string
SWIFT / BIC code.
string
6-digit UK sort code (for GBP Faster Payments).
string
Guaranteed quote ID from POST /v1/fx/quotes if performing a cross-currency payout.
string
Transfer memo or narration displayed on recipient’s bank statement.

Response

string
Transaction UUID.
string
Unique payout reference code (e.g. PO-A1B2C3D4).
string
Transaction type (PAYOUT).
string
Processing status: PROCESSING (for instant local NIP) or PENDING (for cross-currency FX payouts).
string
Payout currency code.
string
Amount in minor currency units as a string (e.g. 2500000 = 25,000.00 NGN).
string
Total NGN debit amount in minor units.
string
Recipient legal name.
object
Rail reference and integration provider metadata.
string
ISO creation timestamp.
string
Settlement completion timestamp, or null if in-flight.
object
Detailed payout execution breakdown.