Skip to main content
GET
Afriex SDK
It validates the account number and institution code and returns the recipient’s details.
Pass the channel, the account’s countryCode, and the institution code from List Institutions. Name lookup isn’t available in every country, so send the request and read the response. If lookup is available, you get the recipient’s details. If it isn’t, the request returns 400 and says account name lookup isn’t available in that country. Ask your customer for the recipient’s name instead.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

Headers

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Query Parameters

channel
enum<string>
required

The payment method channel to resolve

Available options:
MOBILE_MONEY,
BANK_ACCOUNT
accountNumber
string

The account to resolve: a bank account number for BANK_ACCOUNT (required, at least 8 characters), or a phone number for MOBILE_MONEY.

institutionCode
string
required

Required for both channels. The bank code (at least 3 characters) for BANK_ACCOUNT, or the mobile money provider code (for example MTN; at least 3 characters) for MOBILE_MONEY.

countryCode
string
required

The ISO 3166-1 alpha-2 country code. A country with no account name lookup for the channel returns 400.

Example:

"NG"

Response

Payment method resolved successfully.

data
object