A payout sends money out of your Orqex balance to a recipient. The destination is a
typed instrument: a mobile-money or wallet phone number, a bank account, or a
crypto address. Orqex picks the gateway from your project’s payout routing rules.
Create a payout
curl https://api.orqex.com/v1/payouts \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-H "X-Idempotency-Key: payout-1024" \
-d '{
"amount": 5000,
"currency": "XOF",
"method": "momo_mtn",
"instrument": {
"type": "phone",
"phone_number": "+22990000000",
"country": "BJ"
}
}'
Request body
Amount to send, in minor units (e.g. 5000 for 50.00). Minimum 1.
Three-letter ISO 4217 currency code.
Payout method code, e.g. momo_mtn, momo_orange, momo_moov, wallet_wave,
wallet_djamo, momo_mpesa, momo_airtel.
Typed destination. The required fields depend on instrument.type.
Up to 10 arbitrary key/value pairs, stored on the payout.
Instrument types
phone
bank_account
crypto_address
{
"type": "phone",
"phone_number": "+22990000000",
"country": "BJ"
}
phone_number and country (ISO 3166-1 alpha-2) are required.{
"type": "bank_account",
"account_name": "Awa Diallo",
"account_number": "CI93CI0080111301134291200589",
"bank_code": "CI008",
"swift_bic": "BICICIAB",
"country": "CI"
}
account_name, account_number, bank_code and country are required;
swift_bic is optional.{
"type": "crypto_address",
"address": "TQ5...",
"network": "TRON",
"memo_tag": "12345"
}
address and network are required; memo_tag is optional.Response
Public payout id (e.g. po_...).
The payout method code used.
pending, processing, completed, failed, cancelled or reversed.
The destination instrument. recipient is obfuscated; the full instrument is never returned.
Payout fee in minor units.
Gateway transaction reference, when available.
List & retrieve
curl https://api.orqex.com/v1/payouts \
-H "Authorization: Bearer sk_live_xxx"
Payouts are also used behind the scenes by refund via payout: when a gateway has no
native refund support and the project allows it, a refund can be returned to the original
payer as a payout. See Refund a payment. 
