apyhub
Back
▣ FINANCE · STANDARD DATA

Bank List API

What it does

Bank Directory gives you a simple way to look up supported countries and the banks available in each one. Send a country code, get back the country list or a bank list with the fields exposed by the schema: name, code, currency for countries, and id, name, code, SWIFT for banks.

Use it when you need reference data for bank selection forms, payout setup, or payment onboarding flows. The country endpoint returns ISO 3166-1 alpha-2 codes alongside the country name and ISO 4217 currency code, which makes it easier to build country-aware finance workflows. The bank endpoint is scoped to a supported country code such as NG, GH, IN, or SG and returns the banks known for that market.

Bank Directory is best for systems that need a maintained bank list without scraping or hardcoding it into your application. It keeps the response shape small and predictable, so you can populate dropdowns, validate user selections, or map local bank details to SWIFT/BIC data where available.

▣ ENDPOINT 01 / 02
GET
List supported countries
https://api.eu.apyverse.com/testcreate/bank-list-api

QUICKSTART

GUIDE

Quickstart

Fetch the list of bank countries with a simple GET request.

curl -X GET "https://api.eu.apyverse.com/testcreate/bank-list-api" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a data array. Each item in data is an object with name, code, and currency fields describing a country and its ISO codes.

{
  "data": [
    {
      "name": "Nigeria",
      "code": "NG",
      "currency": "NGN"
    }
  ]
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the list of supported countries for the bank list API. The response is a JSON object containing a data array of country objects.

Response

Returns a JSON object with a data array field. Each item in data is an object with name, code, and currency string fields.

ParameterTypeMandatoryDescription
dataObject ArrayYesArray of country objects. Each object includes:
- name — String
- code — String, ISO 3166-1 alpha-2 country code
- currency — String, ISO 4217 currency code
▣ ENDPOINT 02 / 02
GET
List banks for a country
https://api.eu.apyverse.com/testcreate/bank-list-api/countries/:country

QUICKSTART

GUIDE

Quickstart

Fetch the list of banks for a country by putting the country code in the path.

curl -X GET "https://api.eu.apyverse.com/testcreate/bank-list-api/countries/:country/NG" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a data array. Each item in the array is an object with id (integer), name (string), code (string or null), and SWIFT (string or null).

{
  "data": [
    {
      "id": 1,
      "name": "Access Bank",
      "code": "044",
      "SWIFT": "ABNGNGLA"
    }
  ]
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the list of banks for the specified country. The country code is provided as a path parameter, and the response contains a JSON object with a data array of bank records.

Path Parameter(s)

AttributeTypeMandatoryDescription
countryStringYesTwo-letter country code. Allowed values: ZW, NG, LS, MW, MZ, ZM, CD, EG, TZ, GH, CN, IN, PK, BD, PH, MY, NP, SG, LK, TH.

Response

Returns a JSON object with a data array field. Each item in data is an object with required id (integer), name (string), code (string or null), and SWIFT (string or null) fields.

ParameterTypeMandatoryDescription
dataObject ArrayYesArray of bank objects. Each item includes id, name, code, and SWIFT.
data[].idIntegerYesPosition of the bank in the sorted list, starting at 1.
data[].nameStringYesBank name.
data[].codeStringYesLocal bank code, or null when the country has none or it is unknown.
data[].SWIFTStringYesSWIFT/BIC code, or null when unknown.
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.