A payment account is a uniquely identifiable entity that serves the purpose of a recipient to send money to (e.g. a remittance recipient).
This endpoint allows you to create payment accounts of both Mobile Money and Bank Account types, which can subsequently serve as recipient accounts for making payouts.
Although HTTP POST is not inherently idempotent, with this endpoint, you can confidently retry the same request without inadvertently creating duplicate records. Our process involves checking the existence of the payment account first. If it exists, we promptly respond with a
200 OKstatus. Otherwise, we proceed to create a new one and respond with a201 Createdstatus. In both scenarios, the structure of the response body will remain identical.
Mobile Money
The "mobile money" type refers to accounts registered with telecom companies (a.k.a operators) like SAFARICOM in Kenya, and it necessitates a valid mobile number for identification of the payment account within that telecom provider.
The following table outlines the operators supported by our API for each specific country.
| Country | Operators |
|---|---|
| 🇰🇪 KE | SAFARICOM, AIRTEL |
| 🇹🇿 TZ | VODACOM, AIRTEL, TIGO, HALOTEL, TTCL |
| 🇷🇼 RW | AIRTEL, MTN |
| 🇬🇭 GH | AIRTEL, MTN, TIGO, VODAFONE |
| 🇺🇬 UG | AIRTEL, MTN |
| 🇨🇮 CI | MTN, ORANGE, MOOV |
| 🇸🇳 SN | ORANGE, FREE, EXPRESSO |
| 🇨🇲 CM | MTN, ORANGE |
Bank account
The "bank account" type is designated for conventional accounts registered with bank institutions, such as "Equity Bank." It comprises an account number and the associated bank ID, where accounts are registered.
We provide support for numerous banks in each country. Documenting each of them here would be impractical. Therefore, we recommend utilizing the dedicated /v1/banks endpoint to access the most current and accurate list of banks.