Banks
curl --request GET \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>'const options = {
method: 'GET',
headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/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://carbonapistagingsecure.getcarbon.co/baas/api/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 => [
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks"
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "banks fetched successfully",
"data": [
{
"sortCode": "040",
"name": "Olukunle Bank"
},
{
"sortCode": "023",
"name": "CITI Bank"
},
{
"sortCode": "063",
"name": "Access (Diamond) Bank"
},
{
"sortCode": "050",
"name": "EcoBank"
},
{
"sortCode": "070",
"name": "Fidelity Bank"
},
{
"sortCode": "011",
"name": "First Bank"
},
{
"sortCode": "214",
"name": "First City Monument Bank (FCMB)"
},
{
"sortCode": "058",
"name": "Guarantee Trust Bank"
},
{
"sortCode": "030",
"name": "Heritage Bank"
},
{
"sortCode": "301",
"name": "Jaiz Bank"
},
{
"sortCode": "082",
"name": "Keystone Bank"
},
{
"sortCode": "076",
"name": "Polaris Bank"
},
{
"sortCode": "101",
"name": "Providus Bank"
},
{
"sortCode": "221",
"name": "Stanbic IBTC Bank"
},
{
"sortCode": "068",
"name": "Standard Chartered"
},
{
"sortCode": "232",
"name": "Sterling Bank"
},
{
"sortCode": "032",
"name": "Union Bank"
},
{
"sortCode": "033",
"name": "United Bank For Africa (UBA)"
},
{
"sortCode": "215",
"name": "Unity Bank"
},
{
"sortCode": "035",
"name": "Wema Bank"
},
{
"sortCode": "057",
"name": "Zenith Bank"
},
{
"sortCode": "100",
"name": "SunTrust B"
},
{
"sortCode": "103",
"name": "Globus Bank"
},
{
"sortCode": "565",
"name": "One Finance (Carbon)"
},
{
"sortCode": "000025",
"name": "Titan Trust Bank"
},
{
"sortCode": "000026",
"name": "Taj Bank"
},
{
"sortCode": "560",
"name": "Page Financials"
},
{
"sortCode": "090110",
"name": "VFD MFB (V Bank)"
},
{
"sortCode": "090175",
"name": "HighStreet MFB (Rubies)"
},
{
"sortCode": "090198",
"name": "RenMoney Microfinance Bank"
},
{
"sortCode": "090267",
"name": "Kuda Bank"
},
{
"sortCode": "090325",
"name": "Sparkle"
},
{
"sortCode": "090328",
"name": "Eyowo"
},
{
"sortCode": "327",
"name": "Paga"
},
{
"sortCode": "306",
"name": "eTranzact"
},
{
"sortCode": "305",
"name": "Paycom (Opay)"
},
{
"sortCode": "100011",
"name": "Mkudi"
},
{
"sortCode": "100022",
"name": "GoMoney"
},
{
"sortCode": "100025",
"name": "KongaPay"
},
{
"sortCode": "100033",
"name": "PalmPay Limited"
},
{
"sortCode": "329",
"name": "PayAttitude Online"
},
{
"sortCode": "110007",
"name": "TeamApt Limited"
},
{
"sortCode": "044",
"name": "Access Bank"
},
{
"sortCode": "110003",
"name": " Interswitch Limited"
},
{
"sortCode": "090292",
"name": " Afekhafe MFB"
},
{
"sortCode": "090531",
"name": "Aku MFB"
},
{
"sortCode": "090277",
"name": " Alhayat MFB "
},
{
"sortCode": "090469",
"name": " Aniocha MFB"
},
{
"sortCode": "090268",
"name": " Adeyemi College Staff Microfinance bank"
}
]
}Banks
Get Banks
Retrieve a list of banks and financial institutions
GET
/
v1
/
banks
Banks
curl --request GET \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>'const options = {
method: 'GET',
headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/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://carbonapistagingsecure.getcarbon.co/baas/api/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 => [
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks"
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "banks fetched successfully",
"data": [
{
"sortCode": "040",
"name": "Olukunle Bank"
},
{
"sortCode": "023",
"name": "CITI Bank"
},
{
"sortCode": "063",
"name": "Access (Diamond) Bank"
},
{
"sortCode": "050",
"name": "EcoBank"
},
{
"sortCode": "070",
"name": "Fidelity Bank"
},
{
"sortCode": "011",
"name": "First Bank"
},
{
"sortCode": "214",
"name": "First City Monument Bank (FCMB)"
},
{
"sortCode": "058",
"name": "Guarantee Trust Bank"
},
{
"sortCode": "030",
"name": "Heritage Bank"
},
{
"sortCode": "301",
"name": "Jaiz Bank"
},
{
"sortCode": "082",
"name": "Keystone Bank"
},
{
"sortCode": "076",
"name": "Polaris Bank"
},
{
"sortCode": "101",
"name": "Providus Bank"
},
{
"sortCode": "221",
"name": "Stanbic IBTC Bank"
},
{
"sortCode": "068",
"name": "Standard Chartered"
},
{
"sortCode": "232",
"name": "Sterling Bank"
},
{
"sortCode": "032",
"name": "Union Bank"
},
{
"sortCode": "033",
"name": "United Bank For Africa (UBA)"
},
{
"sortCode": "215",
"name": "Unity Bank"
},
{
"sortCode": "035",
"name": "Wema Bank"
},
{
"sortCode": "057",
"name": "Zenith Bank"
},
{
"sortCode": "100",
"name": "SunTrust B"
},
{
"sortCode": "103",
"name": "Globus Bank"
},
{
"sortCode": "565",
"name": "One Finance (Carbon)"
},
{
"sortCode": "000025",
"name": "Titan Trust Bank"
},
{
"sortCode": "000026",
"name": "Taj Bank"
},
{
"sortCode": "560",
"name": "Page Financials"
},
{
"sortCode": "090110",
"name": "VFD MFB (V Bank)"
},
{
"sortCode": "090175",
"name": "HighStreet MFB (Rubies)"
},
{
"sortCode": "090198",
"name": "RenMoney Microfinance Bank"
},
{
"sortCode": "090267",
"name": "Kuda Bank"
},
{
"sortCode": "090325",
"name": "Sparkle"
},
{
"sortCode": "090328",
"name": "Eyowo"
},
{
"sortCode": "327",
"name": "Paga"
},
{
"sortCode": "306",
"name": "eTranzact"
},
{
"sortCode": "305",
"name": "Paycom (Opay)"
},
{
"sortCode": "100011",
"name": "Mkudi"
},
{
"sortCode": "100022",
"name": "GoMoney"
},
{
"sortCode": "100025",
"name": "KongaPay"
},
{
"sortCode": "100033",
"name": "PalmPay Limited"
},
{
"sortCode": "329",
"name": "PayAttitude Online"
},
{
"sortCode": "110007",
"name": "TeamApt Limited"
},
{
"sortCode": "044",
"name": "Access Bank"
},
{
"sortCode": "110003",
"name": " Interswitch Limited"
},
{
"sortCode": "090292",
"name": " Afekhafe MFB"
},
{
"sortCode": "090531",
"name": "Aku MFB"
},
{
"sortCode": "090277",
"name": " Alhayat MFB "
},
{
"sortCode": "090469",
"name": " Aniocha MFB"
},
{
"sortCode": "090268",
"name": " Adeyemi College Staff Microfinance bank"
}
]
}Overview
This endpoint retrieves a list of banks and financial institutions.Endpoint
GET /v1/banks
Headers
x-carbon-key: <your_api_key>
Response
{
"status": "success",
"message": "banks fetched successfully",
"data": [
{
"sortCode": "058",
"name": "Guarantee Trust Bank"
},
{
"sortCode": "011",
"name": "First Bank"
}
]
}
⌘I