Documentation
Payout

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.

CountryCurrencyPayout MethodMinimum AmountMaximum Amount
USAUSDACH, Wire1 USD100,000 USD
NigeriaNGNBank Transfer500 NGN20,000,000 NGN
AustraliaAUDBank Transfer20 AUD20,000 AUD
KenyaKESM-pesa150 KES100,000 KES
United KingdomGBPBank Transfer1 GBP10,000 GBP
United KingdomEURSEPA1 EUR10,000 EUR

The flow for payout is as follows:

  1. Add the beneficiary
  2. Initiate payout
  3. Authorize/finalize payout
  4. 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.

ParameterDescriptionRequired
amount amount you want to send in smaller denominations ie 1 USD = 100 cents.
sourceWalletCurrencyIndicates 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.

ParameterDescriptionRequired
transactionIdthe transaction identifier returned when you initiate a payout.

📘 Payout Statuses

A payout transaction status can be any of the following

Text
 
PENDING
PROCESSING
SUCCESS
FAILED
 

How many minutes does it take between initiating a transaction and finalising rate updates? - Approximately 4 minutes.