Payment Methods
Resolve payment method recipient by account number
Resolves payment method user information for bank accounts or mobile money.
get/api/v1/payment-method/resolve
Request
- Base URLhttps://sandbox.api.afriex.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
channel'MOBILE_MONEY' | 'BANK_ACCOUNT' required
The payment method channel to resolve
accountNumberstring
The account to resolve: a bank account number for BANK_ACCOUNT (required, at least 8 characters), or a phone number for MOBILE_MONEY.
institutionCodestring 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.
countryCodestring required
Example:NG
The ISO 3166-1 alpha-2 country code. A country with no account name lookup for the channel returns 400.
Response
Payment method resolved successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.