Account Lookup

Name-resolves a bank or mobile-money account before initiating a payout — confirm the account is valid and pre-fill the account_name on your Initialize request. Nigeria resolves by bank_code; Ghana resolves by mobile money (type=mobile_money with the network in bank_code, e.g. MTN).

Account lookupGET/api/payouts/account-lookup

Request

Name-resolve an account with GET /api/payouts/account-lookup before building the Initialize beneficiary.

Ghana (mobile money)

Ghana resolves over mobile money: pass type=mobile_money, put the network in bank_code uppercase (e.g. MTN), and use the phone number with the 233 country code as account_number:

GET /api/payouts/account-lookup?country=GH&type=mobile_money&bank_code=MTN&account_number=233246838933

Account Lookup

Query Parameters

countrystringRequired

Country code of the destination account — 'NG' (Nigeria, bank) or 'GH' (Ghana, mobile money).

typestringMobile-money countries

Destination type. Set to 'mobile_money' for mobile-money countries such as Ghana. Omit for bank countries such as Nigeria.

bank_codestringRequired

Bank code for banks (e.g. Nigeria '058'), or the mobile-money network in uppercase (e.g. Ghana 'MTN').

account_numberstringRequired

Bank account number (e.g. Nigeria '0123456789'), or the recipient's phone number with country code for mobile money (e.g. Ghana '233246838933').

Account Lookup - Request

Account Lookup Response

data.account_nameString

Name registered on the resolved account. Use this value as account_name when constructing the beneficiary on Initialize.

data.account_numberString

Echo of the account number that was resolved.

data.bank_codeString

Normalized bank code from the underlying rail (may differ from the input bank_code).

data.bank_nameString

Display name of the resolving bank or mobile-money provider.

data.countryString

Two-letter ISO country code of the resolved account.

data.is_verifiedBoolean

True when the rail successfully resolved a name for the account; false when the account couldn't be verified.

Account Lookup - Response