chukwukaeze / ng-banks

Lightweight Zero dependency npm package to get list of banks in Nigeria (Recognized by CBN)

NG-BANKS

NG-BANKS is a lightweight zero-dependency npm package that can be used to get the list of banks in my great country, Nigeria.

Installation

> npm install ng-banks --save

Usage

The package is very simple and as of the time of writing has only one method which is to get a list of banks, their corresponding shortcode and their USSD code.

The list of banks contains all banks recognized by the Central Bank of Nigeria (CBN).

Now that we've gotten this out of the way here's an example

const ngBanks = require('ng-banks');

const banks = ngBanks.getBanks();

// get bank by slug or code
console.log(ngBanks.getBank('EBN')); // { name: 'ECOBANK NIGERIA PLC', code: '050', slug: 'EBN', ussd: {code: '*326#' } }
console.log(ngBanks.getBank('063')); // { name: 'ACCESS(DIAMOND) BANK PLC', code: '063', slug: 'DMB', ussd: {code: '*710#' } }

ngBanks.getBank('EBN', function(err, bank) {
  console.log(err, bank); // { name: 'ECOBANK NIGERIA PLC', code: '050', slug: 'EBN', ussd: {code: '*326#' } }
});
ngBanks.getBank('063', function(err, bank) {
  console.log(err, bank); // { name: 'ACCESS(DIAMOND) BANK PLC', code: '063', slug: 'DMB', ussd: {code: '*710#' } }
});

CONTRIBUTORS

See also the list of contributors who have contributed to this project.

License

MIT