Get

The lookup resource facilitates the retrieval of metadata associated with mobile money or bank accounts. For instance, prior to creating payment accounts, you can utilize this endpoint to validate whether an account number corresponds to a specific business or individual.

This functionality proves especially valuable in ensuring that only validated payment accounts are utilized; for example, when integrated with other processes, such as payouts, it helps mitigate the risk of costly reversals or refunds resulting from funds being sent to an incorrect recipient.

Account not found

While we strive to ensure that our lookup sources are always up to date with the most recent data, we must consider instances when we cannot retrieve metadata for a requested payment account.

In such cases, our API will respond with the error code LOOKUP_ACCOUNT_NOT_FOUND, providing a way to programmatically determine whether the account lookup was unsuccessful.

Lookups reliability varies a lot between countries. If you receive a 500 error, please wait a few minutes and try your request again.

Supported countries/account types

To view the complete list of supported countries and payment accounts, visit the Country support section in the General tab.

Each country page indicates whether lookup functionality is available for that specific country.

Path Params
string
required

The account number, that is either the mobile money number or bank account number

Query Params
string
enum
required

The payment account type to lookup for

Allowed:
string

If payment_account_type is BANK_ACCOUNT, this will be a mandatory field representing the bank id (bnk-xxx) used to identify which bank the account number belongs to

string
enum

If payment_account_type is MOBILE_MONEY, this will be a mandatory field representing the mobile money operator

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json