Create a payout
Payouts
Create a payout
Send an outbound payout to a typed instrument. The destination shape depends on instrument.type: phone, bank_account or crypto_address. Whether the destination country is reachable is decided by the project’s payout routing rules.
POST
Create a payout
Authorizations
Project secret key, e.g. sk_live_..., sent as Authorization: Bearer sk_....
Headers
Safely retry a write without duplicating it. 8-128 chars.
Required string length:
8 - 128Body
application/json
Payout amount in minor units (e.g. 5000 for 50.00). Minimum 1.
Required range:
x >= 1Three-letter ISO 4217 currency code.
Required string length:
3Payout method code.
Available options:
momo_mtn, momo_orange, momo_moov, wallet_wave, momo_mpesa, momo_airtel, momo_tigo, momo_vodacom, momo_vodafone, wallet_djamo, momo_togocel, momo_eu_mobile, momo_e_money, momo_freemoney, momo_halopesa, momo_zamtel, momo_tnm, momo_amanata, wallet_my_nita, momo_zamani_cash Typed destination for the payout. Fields depend on type:
phone:phone_number,country.bank_account:account_name,account_number,bank_code,country, optionalswift_bic.crypto_address:address,network, optionalmemo_tag.
Up to 10 arbitrary key/value pairs, stored on the payout.