Method codes
Pass one of these as the method field when creating a payout.
Mobile money
| Code | Network |
|---|
momo_mtn | MTN Mobile Money |
momo_orange | Orange Money |
momo_moov | Moov Money |
momo_mpesa | M-Pesa |
momo_airtel | Airtel Money |
momo_tigo | Tigo Pesa |
momo_vodacom | Vodacom M-Pesa |
momo_vodafone | Vodafone Cash |
momo_togocel | Togocel T-Money |
momo_eu_mobile | EU Mobile Money |
momo_e_money | E-Money |
momo_freemoney | Free Money |
momo_halopesa | HaloPesa |
momo_zamtel | Zamtel Kwacha |
momo_tnm | TNM Mpamba |
momo_amanata | Amanata Money |
momo_zamani_cash | Zamani Cash |
Wallets
| Code | Provider |
|---|
wallet_wave | Wave |
wallet_djamo | Djamo |
wallet_my_nita | My Nita |
Crypto
| Code | Asset |
|---|
crypto | Generic (network determined by instrument) |
crypto_btc | Bitcoin |
crypto_eth | Ethereum |
crypto_usdt | Tether (USDT) |
crypto_usdc | USD Coin (USDC) |
Bank transfer
| Code | Type |
|---|
bank_transfer | Local or international bank transfer |
Instrument types
The instrument object on a payout describes the typed destination. The type field
determines which sub-fields are required.
phone
bank_account
crypto_address
Used with mobile-money (momo_*) and wallet (wallet_*) methods.| Field | Required | Description |
|---|
type | Yes | "phone" |
phone_number | Yes | E.164-formatted phone number (e.g. +22990000000). |
country | Yes | ISO 3166-1 alpha-2 country code (e.g. "BJ"). |
Used with bank_transfer.| Field | Required | Description |
|---|
type | Yes | "bank_account" |
account_name | Yes | Account holder name. |
account_number | Yes | Account number or IBAN. |
bank_code | Yes | Local bank identifier code. |
country | Yes | ISO 3166-1 alpha-2 country code. |
swift_bic | No | BIC/SWIFT code. |
Used with crypto and crypto_* methods.| Field | Required | Description |
|---|
type | Yes | "crypto_address" |
address | Yes | On-chain wallet address. |
network | Yes | Blockchain network (e.g. "TRON", "ETH", "BTC"). |
memo_tag | No | Memo or destination tag (required by some networks such as XRP, EOS). |
Routing
Whether a given method reaches a gateway is controlled by your project’s payout routing
rules, configured in the dashboard. A routing rule binds a method (and optionally a country)
to a payout gateway account. If no matching rule exists for the requested method, the payout
is rejected at creation time.
Payout routing has no automatic failover. Each payout uses exactly one gateway account. If
the selected gateway fails, the payout reaches failed and must be retried explicitly.
