Collections
The collections API lets you receive money via bank transfers or mobile money accounts. We currently support collections from 3 countries.
The table below gives more information on the countries and other important collection details.
| Country | Currency | Payment Method | Minimum Amount | Maximum Amount |
|---|---|---|---|---|
| Nigeria | NGN | Bank Transfer | 100NGN | 2000000 NGN |
| Kenya | KES | Mobile Money | 20 KES | 145000 KES |
| Uganda | UGX | Mobile Money | 500 UGX | 4000000 UGX |
The flow for payout is as follows -
- Initiate collection
- Await transaction webhook or track transaction status
To Initiate collection, the following parameters are required.
| Parameter | Description | Required |
|---|---|---|
amount | amount you want to send | ✅ |
country | Indicates the country code for the transaction. KE - Kenya NG - Nigeria UG - Uganda | ✅ |
currency | Indicates the currency you are collecting. Options are: KES NGN UGX | |
customerEmail | Represents the email address of the customer associated with the transaction. | ✅ |
reference | A reference to track the transaction | ✅ |
description | Provides context or explains the intent of the transaction. | ✅ |
payload | This is the account/mobile number details to be collected from. | ✅ |
Note that the payload varies depending on the country to be collected from. Specific details per country are provided on the collection payload page.