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
}
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 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

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[]
​
page
integer

Current page number

​
total
integer

Total number of items available