Nigerian Bank List

The Nigerian Bank List endpoint retrieves the financial institutions available for NGN payout transactions through LedgerBlock.

Use this endpoint to retrieve the list of supported banks and their corresponding bank codes. The bank_code returned for a financial institution is used when identifying the beneficiary's bank in subsequent payout and bank account verification requests.

Important: Dedicated API Key Required

This endpoint uses a dedicated API key and does not use the regular LedgerBlock API key.

Use the following API key specifically for the List Banks endpoint:

cf002c2f7c9b7a3e3280cf5d77ab539467dc

Configure this key as the Bearer_Token when making the request.

Authentication

AuthenticationRequiredValue
Bearer TokenYescf002c2f7c9b7a3e3280cf5d77ab539467dc

Request

To retrieve the Nigerian bank list, send a GET request with NGN as the currency query parameter.

GET {{base_url}}/api/v1/payout/bank-list?currency=NGN

Query Parameters

NameTypeRequiredDescription
currencyStringYesCurrency for the bank list. Use NGN to retrieve Nigerian financial institutions.

Example Request

curl --location -g '{{base_url}}/api/v1/payout/bank-list?currency=NGN' \
--header 'Authorization: Bearer {{bearer_token}}'

Response

200 OK

{
  "status": "success",
  "message": "fetched",
  "data": [
    {
      "bank_code": "000019",
      "bank_name": "Enterprise Bank"
    },
    {
      "bank_code": "000025",
      "bank_name": "Titan Trust Bank"
    },
    {
      "bank_code": "000026",
      "bank_name": "Taj Bank Limited"
    }
  ]
}

The endpoint returns the financial institutions available for the requested currency. Each institution contains a bank_code and bank_name.

Response Fields

KeyTypeDescription
statusStringIndicates the result of the request.
messageStringMessage describing the result of the request.
dataArrayList of financial institutions available for the requested currency.
data[].bank_codeStringUnique code identifying the financial institution.
data[].bank_nameStringName of the financial institution.

Using the Bank List

When building a payout flow, retrieve this list and allow the user or your system to select the appropriate bank.

Get Bank List → Select Bank → Obtain bank_code → Verify Bank Account → Initiate Payout

Use the bank_code returned by this endpoint whenever a subsequent LedgerBlock payout or bank account verification request requires identification of the beneficiary's financial institution.

Note: Do not hardcode the bank list in your application. Retrieve the current list from this endpoint so that newly supported financial institutions can be reflected automatically.


Did this page help you?