List institutions

Returns every bank (or mobile money provider) that can receive a payout in the given country and currency, each with the provider_code to pass as destination_provider_code when creating a payout. The processor routes on that code — a display name is never accepted in its place.

GET /v1/banks

List institutions

cURL

curl --request GET \
  --url https://api.spendin.app/v1/banks \
  --header 'X-API-Key: <api-key>'

200

[
  {
    "provider_name": "ACCESS BANK",
    "provider_code": "044",
    "destination_type": "BANK_ACCOUNT"
  }
]

Authorizations

X-API-Key · string · header · required

Query Parameters

country · string · required

ISO 3166-1 alpha-2 country code

Example:

"NG"

currency · string · required

ISO 4217 currency code

Example:

"NGN"

destination_type · enum<string> · default: BANK_ACCOUNT

Which kind of institution to list. Banks and mobile money providers come from the same upstream directory but are never mixed in a response.

Available options: BANK_ACCOUNT, MOBILE_MONEY

Response

200

application/json

provider_name · string · required

Display name. Never sent as a routing value.

Example:

"ACCESS BANK"

provider_code · string · required

Pass this as destination_provider_code when creating a payout — it is what the processor routes on.

Example:

"044"

destination_type · enum<string> · required

Available options: MOBILE_MONEY, BANK_ACCOUNT, CRYPTO_WALLET

Example:

"BANK_ACCOUNT"