Skip to main content
GET
/
api
/
v1
/
payment-method
/
resolve
Resolve payment method recipient by account number
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/payment-method/resolve \
  --header 'x-api-key: <api-key>'
{ "data": { "recipientName": "John Doe", "institutionName": "GUARANTY TRUST BANK", "institutionCode": "000013" } }
Resolve payment method user information for bank accounts or mobile money. This endpoint validates and retrieves recipient details based on account number and institution code.

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. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

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 (e.g. 2025-12-28). Defaults to latest stable.

Query Parameters

​
channel
enum<string>
required

The payment method channel to resolve

Available options:
MOBILE_MONEY,
BANK_ACCOUNT
​
accountNumber
string

Bank account number (required for BANK_ACCOUNT channel) or phone number (required for MOBILE_MONEY channel)

​
institutionCode
string

Bank code (required for BANK_ACCOUNT channel)

​
countryCode
enum<string>
required

The ISO 3166-1 alpha-2 country code. The accepted values depend on channel: BANK_ACCOUNT supports only NG and GH; MOBILE_MONEY supports the remaining countries listed in the enum.

Available options:
NG,
GH,
ET,
KE,
MG,
MW,
MZ,
RW,
TZ,
UG,
CM,
CG,
GA,
CF,
CI,
BF,
ML,
SN,
TG,
BJ,
NE,
GN,
ZM

Response

Payment method resolved successfully.

​
data
object