const institutions = await afriex.paymentMethods.getInstitutions({
channel: "BANK_ACCOUNT",
countryCode: "NG",
});
// Returns: Institution[], { institutionName, institutionCode, institutionBranch (bank), institutionAddress (bank and SWIFT) }
curl --request GET \
--url https://sandbox.api.afriex.com/api/v1/payment-method/institution \
--header 'x-api-key: <api-key>'import requests
url = "https://sandbox.api.afriex.com/api/v1/payment-method/institution"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://sandbox.api.afriex.com/api/v1/payment-method/institution', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.afriex.com/api/v1/payment-method/institution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.afriex.com/api/v1/payment-method/institution"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.api.afriex.com/api/v1/payment-method/institution")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/payment-method/institution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}List Institutions
Retrieves a list of banks or mobile money providers available for a specific country.
const institutions = await afriex.paymentMethods.getInstitutions({
channel: "BANK_ACCOUNT",
countryCode: "NG",
});
// Returns: Institution[], { institutionName, institutionCode, institutionBranch (bank), institutionAddress (bank and SWIFT) }
curl --request GET \
--url https://sandbox.api.afriex.com/api/v1/payment-method/institution \
--header 'x-api-key: <api-key>'import requests
url = "https://sandbox.api.afriex.com/api/v1/payment-method/institution"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://sandbox.api.afriex.com/api/v1/payment-method/institution', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.afriex.com/api/v1/payment-method/institution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.afriex.com/api/v1/payment-method/institution"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.api.afriex.com/api/v1/payment-method/institution")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/payment-method/institution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}channel as well as countryCode to list only the providers for that payment channel.Authorizations
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. Manage your keys and their permissions under Developer → API keys in the dashboard.
A request whose key does not carry the permission the target
endpoint requires is rejected with 401 Unauthorized, the same
response an unrecognised, malformed, revoked or disabled key
returns. The API does not distinguish the two cases on the wire.
See the Permissions reference for the permission each endpoint requires.
Headers
Signature of the request payload, used for request authentication where payload signing is enabled for your business.
API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.
Query Parameters
The payment method channel. Institution lookup is only implemented for these three channels; any other channel returns 400 INVALID_TRANSACTION_CHANNEL.
BANK_ACCOUNT, SWIFT, MOBILE_MONEY The ISO 3166-1 alpha-2 country code. Institutions are available only for the countries listed.
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 