Skip to main content
GET
/
api
/
v1
/
payment-method
/
institution
Get list of payment method institutions by country
curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/payment-method/institution \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "institutionName": "Guaranty Trust Bank (GTBank) Plc",
      "institutionCode": "000013",
      "institutionBranch": "",
      "institutionAddress": ""
    },
    {
      "institutionName": "Zenith Bank",
      "institutionCode": "000015",
      "institutionBranch": "",
      "institutionAddress": ""
    },
    {
      "institutionName": "Wema Bank",
      "institutionCode": "000017",
      "institutionBranch": "",
      "institutionAddress": ""
    }
  ],
  "total": 38,
  "page": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.afriex.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of banks or mobile money providers available for a specific country and payment channel.

Authorizations

​
x-api-key
string
header
required

Static business API key from the dashboard

Query Parameters

​
channel
enum<string>
required

The payment method channel

Available options:
BANK_ACCOUNT,
SWIFT,
MOBILE_MONEY,
UPI,
INTERAC,
WE_CHAT
​
countryCode
enum<string>
required

The ISO 3166-1 alpha-2 country code

Available options:
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

Response

List of banks or mobile money providers retrieved successfully.

​
data
object[]
​
total
integer
​
page
integer