Move · Payouts
Create a payout
POST/v1/payouts
Sends money from one of your balances to a recipient's bank account or mobile money wallet. The payout starts as processing and moves to settled or failed; you'll get a webhook for each change.
Parameters
amountintegerrequired
Amount in the smallest unit of the currency.
currencystringrequired
Three-letter ISO currency code the recipient receives.
destinationobjectrequired
Country and rail: bank_transfer or mobile_money.
recipientstringrequired
ID of a saved recipient.
referencestringoptional
Your own reference, shown on the recipient's statement where supported.
metadataobjectoptional
Key-value pairs you want returned on the payout.
Request
curl https://api.orbpay.si/v1/payouts \ -H "Authorization: Bearer sk_test_…" \ -d amount=150000 \ -d currency=NGN \ -d destination[country]=NG \ -d destination[rail]=mobile_money \ -d recipient=rcp_7Hq19
Response · 200
{
"id": "po_8Kx2",
"status": "processing",
"amount": 150000,
"currency": "NGN",
"created_at": "2026-10-02T21:04:11Z"
} Events
payout.created payout.compliance_passed payout.fx_locked payout.settled payout.failed