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 MOBILE_MONEY, BANK_ACCOUNT, BANK_ACCOUNT_ROUTE, and ALIAS 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 OK status. Otherwise, we proceed to create a new one and respond with a 201 Created status. 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 | AT, MTN, VODAFONE |
| 🇺🇬 UG | AIRTEL, MTN |
| 🇨🇮 CI | MTN, ORANGE, MOOV |
| 🇸🇳 SN | ORANGE, FREE, EXPRESSO, WAVE |
| 🇨🇲 CM | MTN, ORANGE |
| 🇧🇩 BD | BKASH, NAGAD |
| 🇵🇭 PH | GCASH, MAYA, COINS, GRABPAY |
| 🇵🇰 PK | EASYPAISA, JAZZCASH, UPAISA, SADAPAY, NAYAPAY, FINJA, PAYMAX |
| 🇨🇬 CG | MTN, AIRTEL |
| 🇬🇦 GA | AIRTEL, MOOV |
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.
Bank Account Route
The BANK_ACCOUNT_ROUTE type is used for accounts that require both a routing code and an account number to identify the recipient bank account. This payment account type is common in payment systems that rely on routing details, such as sort codes, IFSC, etc., to direct funds accurately to the destination bank or branch.
The following table outlines the routing code supported by our API for each specific country:
| Country | Routing Code |
|---|---|
| 🇮🇳 IN | IFSC (Indian Financial System Code) |
| 🇧🇩 BD | Bank Routing Number |
Alias
The ALIAS type represents accounts identified by a virtual or alternative payment handle rather than traditional bank account details or a mobile number. It is commonly used in payment systems where recipients can receive funds using simple identifiers such as an email address, phone number, or payment handle (e.g. UPI Virtual Payment Address).
The following table outlines the alias networks supported by our API for each specific country:
| Country | Network | Identifier |
|---|---|---|
| 🇮🇳 IN | UPI | Virtual Payment Address (VPA) |