#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 |
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 transaction identifier returned when you initiate a payout. | ✅ |