List Banks

Fetch a list of all banks supported by 100Pay for bank transfers. Use the returned bank codes when verifying accounts or executing transfers.

Usage


import { Pay100 } from "@100pay-hq/100pay.js";
 
const client = new Pay100({
  publicKey: "your_public_key",
  secretKey: "your_secret_key",
});
 
const banks = await client.bankTransfer.getBankList();
 
console.log(`${banks.data.count} banks available`);
banks.data.banks.forEach((bank) => {
  console.log(`${bank.name} — code: ${bank.bankCode}`);
});

Response


{
  "statusCode": 200,
  "message": "Banks retrieved successfully",
  "data": {
    "count": 35,
    "banks": [
      {
        "name": "Access Bank",
        "bankCode": "044",
        "alias": ["access"],
        "routingKey": "access",
        "logoImage": "https://...",
        "nubanCode": "000014"
      },
      {
        "name": "Guaranty Trust Bank",
        "bankCode": "058",
        "alias": ["gtb", "gtbank"],
        "routingKey": "gtbank",
        "logoImage": "https://..."
      }
      // ...
    ]
  }
}

`IBankListResponse`

Field	Type	Description
`data.count`	`number`	Total number of supported banks
`data.banks`	`IBank[]`	Array of bank objects

`IBank` Object

Field	Type	Description
`name`	`string`	Full bank name
`bankCode`	`string`	Bank code — use this in verify and transfer calls
`alias`	`string[]`	Common aliases or short names for the bank
`routingKey`	`string`	Internal routing identifier
`logoImage`	`string \| null`	URL to the bank’s logo image
`nubanCode`	`string \| null`	NUBAN (Nigerian Uniform Bank Account Number) routing code

Finding a Bank by Name


const banks = await client.bankTransfer.getBankList();
 
const accessBank = banks.data.banks.find(
  (bank) => bank.bankCode === "044"
);
 
// Or search by name
const gtb = banks.data.banks.find(
  (bank) => bank.name?.toLowerCase().includes("guaranty")
);

Cache the bank list where possible — it rarely changes and repeated fetching adds unnecessary latency.

Next Steps

Verify Account — confirm the recipient’s account before sending
Execute Transfer — send funds to a verified bank account