Account Lookup

Name-resolves a bank or mobile-money account before initiating a payout. Call this after you've chosen a country and bank_code (see Get Banks) to confirm the account number is valid and pre-fill the account_name on your Initialize request.

Account lookupGET/api/payouts/account-lookup

Request

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

Account Lookup

Query Parameters

countrystringRequired

Two-letter ISO country code of the destination account (e.g. 'NG', 'KE', 'GH').

bank_codestringRequired

Bank or mobile-money provider code from GET /api/payouts/banks/:countryCode.

account_numberstringRequired

Account or mobile number to resolve.

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