Banks

List banks

Returns the supported banks for the given country as { name, bankCode } pairs, sorted by name. Send a bankCode as data.bankCode on a bank_account beneficiary account whose currency is the country’s. Every bankCode is a Zuba identifier (ng_0001, gh_0003, …). For Nigeria, the default when country is omitted, each bank also carries shortCode (its short code in Zuba’s registry: the 3-digit CBN code for most banks, a lettered or longer code for a few) and nipCode (its 6-digit NIP code), plus alternativeCodes where a bank has any; an NGN account accepts every one of those forms as bankCode, so a saved account keeps working whichever form it carries. The Nigerian list is the full registry, not the set of banks a rail has confirmed it can pay.

GET

banks

List banks

curl --request GET \
  --url https://api.example.com/v1/banks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/banks', 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://api.example.com/v1/banks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.example.com/v1/banks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/banks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "bankCode": "gh_0003",
    "name": "GCB Bank PLC",
    "alternativeCodes": [
      "090267"
    ],
    "nipCode": "000013",
    "shortCode": "058"
  }
]

{
  "details": [
    {
      "field": "accounts.0.data",
      "message": "crAccount must be exactly 10 digits for Nigerian accounts"
    }
  ],
  "error": "BAD_REQUEST",
  "message": "crAccount must be exactly 10 digits for Nigerian accounts",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Query Parameters

country

enum<string>

ISO 3166-1 alpha-2 country code. Supported values: NG (default), GH, KE, UG, CM, CI, ZA.

Available options:

NG,

GH,

KE,

UG,

CM,

CI,

ZA

Example:

"GH"

Response

List of banks sorted alphabetically by name

bankCode

string

required

Bank identifier to send as data.bankCode on a bank_account beneficiary account whose currency is this country's

Example:

"gh_0003"

name

string

required

Bank name

Example:

"GCB Bank PLC"

alternativeCodes

string[]

Nigeria only: other codes the bank is also addressed by, which an NGN account accepts as bankCode and a saved account may carry. Present only for banks that have any.

Example:

["090267"]

nipCode

string

Nigeria only: the bank's 6-digit NIP institution code. An NGN account accepts it as bankCode; a saved account's zubaBankCode already names its bank's bankCode here.

Example:

"000013"

shortCode

string

Nigeria only: the bank's short code in Zuba's registry, its 3-digit CBN code for most banks and a lettered or longer code for a few (e.g. B54). An NGN account accepts it as bankCode; a saved account's zubaBankCode already names its bank's bankCode here.

Example:

"058"

List banks

curl --request GET \
  --url https://api.example.com/v1/banks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/banks', 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://api.example.com/v1/banks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.example.com/v1/banks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/banks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "bankCode": "gh_0003",
    "name": "GCB Bank PLC",
    "alternativeCodes": [
      "090267"
    ],
    "nipCode": "000013",
    "shortCode": "058"
  }
]

{
  "details": [
    {
      "field": "accounts.0.data",
      "message": "crAccount must be exactly 10 digits for Nigerian accounts"
    }
  ],
  "error": "BAD_REQUEST",
  "message": "crAccount must be exactly 10 digits for Nigerian accounts",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}