https://github.com/chekalsky/php-banks-db

PHP library for getting bank info (name, brand color etc) by first digits of card's number
https://github.com/chekalsky/php-banks-db

bank bank-card banks-db bin credit-card iin

Last synced: 8 days ago
JSON representation

PHP library for getting bank info (name, brand color etc) by first digits of card's number

• Host: GitHub
• URL: https://github.com/chekalsky/php-banks-db
• Owner: chekalsky
• License: mit
• Created: 2018-07-02T09:50:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-11-16T04:09:45.000Z (almost 3 years ago)
• Last Synced: 2024-10-23T04:52:20.156Z (16 days ago)
• Topics: bank, bank-card, banks-db, bin, credit-card, iin
• Language: PHP
• Homepage:
• Size: 234 KB
• Stars: 147
• Watchers: 7
• Forks: 23
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Banks DB

[![Build Status](https://travis-ci.com/chekalsky/php-banks-db.svg?branch=master)](https://travis-ci.com/chekalsky/php-banks-db) [![codecov](https://codecov.io/gh/chekalsky/php-banks-db/branch/master/graph/badge.svg)](https://codecov.io/gh/chekalsky/php-banks-db)

> It is a PHP port of [ramoona's banks-db](https://github.com/ramoona/banks-db).

Returns bank's name and brand color by bank card number's first digits (BIN, Issuer Identification Numbers, IIN).

### Installation

```

composer require chekalskiy/php-banks-db

```

### Basic usage

```php

$card_prefix = '5275 9400 0000 0000'; // we only need first 6 digits but it could be the whole card number

try {

    $bank_db = new BankDb();

    $bank_info = $bank_db->getBankInfo($card_prefix);

    $result = [

        'is_unknown' => $bank_info->isUnknown(), // is bank unknown

        'name' => $bank_info->getTitle(true),

        'color' => $bank_info->getColor(),

        'type' => $bank_info->getCardType(),

    ];

    return $result;

} catch (BankDbException $e) {

    // todo handle exception

}

```

### About database

We use simple PHP-file with an array inside (it's regenerates every time ramoona's repository is updated). It's very fast and simple way to work with data because of opcache enabled by default in PHP 7. But you can extend `BankDB` class to make it work with redis or something, but for most cases compiled php-file is OK.

#### Database update

Database updates from [original library](https://github.com/ramoona/banks-db) by me. To update php cache file after manual database change run `composer rebuild`.

### Contributions

Feel free to open [an issue](https://github.com/chekalskiy/php-banks-db/issues) on every question you have. If you have new prefixes for database please commit them to [ramoona/banks-db repository](https://github.com/ramoona/banks-db) — I will update them once your PR will me merged there.

---

> It's a community driven database, so it can potentially contains mistakes.

For UI examples see the [original library](https://github.com/ramoona/banks-db).