Institution Codes - Afriex Business API

Resolve bank code to institution name

cURL

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

import requests

url = "https://sandbox.api.afriex.com/api/v1/payment-method/institution/codes?country=US"

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/codes?country=US', 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/codes?country=US",\
  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/codes?country=US"

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/codes?country=US")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.afriex.com/api/v1/payment-method/institution/codes?country=US")

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

Response

200

{
  "data": {
    "bankName": "JPMORGAN CHASE BANK"
  }
}

Resolves payment method user information for bank accounts or mobile money.

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

searchTerm

string

required

The bank code to resolve. A US routing number (8-9 digits) when codeType is routing_number, otherwise a SWIFT code.

country

string

default:US

required

ISO country code of the institution. Defaults to US. routing_number lookups are only supported for US; all other countries use swift_code.

codeType

enum

required

The type of bank code. routing_number is only valid when country is US; for every other country only swift_code is accepted.

Available options:

swift_code, routing_number

Response

200

application/json

Bank code resolved successfully.

{
  "data": {
    "bankName": "JPMORGAN CHASE BANK"
  }
}