#Payout The payouts API allows you to transfer money to bank accounts and mobile money accounts. We currently support payouts to 4 countries.
The table below gives more information on the countries and other important details.
Country | Currency | Payout Method | Minimum Amount | Maximum Amount |
---|---|---|---|---|
USA | USD | ACH, Wire | 100 USD | 100,000 USD |
Nigeria | NGN | Bank Transfer | 1000 NGN | 2,000,000 NGN |
Australia | AUD | Bank Transfer | 20 AUD | 20,000 AUD |
Kenya | KES | M-pesa | 150 KES | 100,000 KES |
Ghana | GHS | Mobile Money | 20 GHS | 300,000 GHS |
Benin | CFA | Mobile Money | 200 CFA | 1,000,000 CFA |
Togo | CFA | Mobile Money | 200 CFA | 1,000,000 CFA |
Senegal | CFA | Mobile Money | 100 CFA | 1,500,000 CFA |
Burkina Faso | CFA | Mobile Money | 500 CFA | 1,000,000 CFA |
Cameroon | CFA | Mobile Money | 200 CFA | 1,000,000 CFA |
Ivory Coast | CFA | Mobile Money | 500 CFA | 5,000,000 CFA |
Guinea-Conakry | CFA | Mobile Money | 10000 CFA | 1,500,000 CFA |
Mali | CFA | Mobile Money | 500 CFA | 1,500,000 CFA |
Uganda | UGX | Mobile money | 4500 UGX | 1,000,000 UGX |
Rwanda | RWF | Mobile Money | 20 RWF | 300,000 RWF |
The flow for payout is as follows:
- Add the beneficiary
- Initiate payout
- Authorize/finalize payout
- Await transaction webhook and/or track transaction status
NB: You can skip the first step if the beneficiary has already been indexed.
To Initiate payout, the following parameters are required.
Parameter | Description | Required |
---|---|---|
amount | amount you want to send in smaller denominations ie 1 USD = 100 cents. | ✅ |
sourceWalletCurrency | Indicates the wallet from which payment is made. Defaults to USD | ✅ |
reference | reference to keep track of your transaction | ✅ |
customerEmail | represents the email address of the customer associated with the transaction. | ✅ |
description | provides context or explains the intent of the transaction. | ✅ |
beneficiaryId | id of the beneficiary that has already been created/indexed | ✅ |
callbackUrl | URL to send webhook to if per this transaction. | ❌ |
To Finalize Payout, the only parameter required is the transaction identifier.
Parameter | Description | Required |
---|---|---|
transactionId | the id returned from initiating the payout. | ✅ |
📘
Payout Statuses
A payout transaction status can be any of the following
Text
PENDING
PROCESSING
SUCCESS
FAILED