Payment Methods
Get list of payment method institutions by country
Retrieves a list of banks or mobile money providers available for a specific country.
get/api/v1/payment-method/institution
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'BANK_ACCOUNT' | 'SWIFT' | 'MOBILE_MONEY' required
The payment method channel. Institution lookup is only implemented for these three channels; any other channel returns 400 INVALID_TRANSACTION_CHANNEL.
countryCode'US' | 'NG' | 'GB' | 'DE' | 'FR' | 'CA' | 'ZA' | 'GH' | 'KE' | 'UG' | 'TZ' | 'RW' | 'CM' | 'CG' | 'GA' | 'CF' | 'CI' | 'BF' | 'ML' | 'SN' | 'TG' | 'BJ' | 'NE' | 'GN' | 'ZM' | 'ET' | 'MW' | 'MZ' | 'BW' | 'SL' | 'LR' | 'GM' | 'GW' | 'CV' | 'ST' | 'AO' | 'KM' | 'DJ' | 'SO' | 'SC' | 'MU' | 'SZ' | 'LS' required
The ISO 3166-1 alpha-2 country code. Institutions are available only for the countries listed.
Response
List of banks or mobile money providers retrieved successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.