Skip to main content
GET
/
api
/
v1
/
payment-method
/
resolve
Resolve payment method recipient by account number
curl --request GET \
  --url https://staging.afx-server.com/api/v1/payment-method/resolve \
  --header 'x-api-key: <api-key>'
{
  "recipientEmail": "jsmith@example.com",
  "recipientPhone": "<string>",
  "recipientAddress": "<string>",
  "recipientName": "<string>"
}
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 from the dashboard

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

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.

​
recipientEmail
string<email>

The email address of the recipient if needed.

​
recipientPhone
string

The phone number of the recipient in E.164 format.

​
recipientAddress
string

The address of the recipient if needed.

​
recipientName
string

The name of the recipient if needed.