List Institutions - Afriex Business API

Afriex SDK

TypeScript

const institutions = await afriex.paymentMethods.getInstitutions({
  channel: "BANK_ACCOUNT",
  countryCode: "NG",
});

// Returns: Institution[], { institutionId, institutionName, institutionCode }

cURL

curl --request GET \
  --url https://sandbox.api.afriex.com/api/v1/payment-method/institution \
  --header 'x-api-key: <api-key>'

Python

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)

JavaScript (Fetch API)

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

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

Go

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

Java (Unirest)

HttpResponse<String> response = Unirest.get("https://sandbox.api.afriex.com/api/v1/payment-method/institution")
  .header("x-api-key", "<api-key>")
  .asString();

Ruby

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

Sample Response

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

Authorizations

Headers

Query Parameters