Banklist – Cashonrails Documentation

Bank List

The Bank List endpoint allows you to retrieve a list of supported banks for a specific currency. This is useful for ensuring compatibility and streamlining the transfer process.

Endpoint

GET https://api.cashonrails.com/api/v1/bank_list/{currency}

Request Headers

Header	Type	Description
Authorization	string	Bearer token with your secret key

Parameters

Parameter	Type	Description
currency	string	The currency code (e.g., NGN, USD)

Sample Request


GET https://api.cashonrails.com/api/v1/bank_list/NGN

Sample cURL Request


curl -X GET https://api.cashonrails.com/api/v1/bank_list/NGN \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_SECRET_KEY"

Sample Response


{
  "success": true,
  "message": "Bank List Retrieved Successfully",
  "data": [
    {
      "bank_code": "044",
      "bank_name": "Access Bank",
      "currency": "NGN"
    },
    {
      "bank_code": "063",
      "bank_name": "Access Bank (Diamond)",
      "currency": "NGN"
    },
    {
      "bank_code": "050",
      "bank_name": "Ecobank Nigeria",
      "currency": "NGN"
    },
    {
      "bank_code": "070",
      "bank_name": "Fidelity Bank",
      "currency": "NGN"
    }
    // ... more banks
  ]
}

Response Parameters

Field	Type	Description
success	boolean	Indicates if the request was successful
status	string	Status code of the request
data	object	Contains the list of banks
banks	array	List of bank objects
code	string	Bank code
name	string	Bank name