Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiwi/card-info
Library for getting card info by its PAN
https://github.com/qiwi/card-info
Last synced: 4 days ago
JSON representation
Library for getting card info by its PAN
- Host: GitHub
- URL: https://github.com/qiwi/card-info
- Owner: qiwi
- License: mit
- Created: 2018-04-01T13:22:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T05:30:31.000Z (21 days ago)
- Last Synced: 2024-10-26T22:46:52.413Z (20 days ago)
- Language: JavaScript
- Size: 376 KB
- Stars: 1
- Watchers: 10
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# card-info
[](http://standardjs.com)
[](https://travis-ci.org/qiwi/card-info)
[](https://coveralls.io/github/qiwi/card-info)
[](https://david-dm.org/qiwi/card-info)
[](https://david-dm.org/qiwi/card-info)
[](https://codeclimate.com/github/qiwi/card-info) [](https://greenkeeper.io/)
Complex utility for getting card info by its PAN.
Supported providers:
* preservice (dumb checks on client-side)
* [Binlist](https://binlist.net/)
* [Braintree](https://github.com/braintree/credit-card-type)
* [Freebinchecker](https://www.freebinchecker.com/bin-api)
* ``
#### Glossary
* BIN/INN — The first six digits of a card number (including the initial [MII digit](https://en.wikipedia.org/wiki/ISO/IEC_7812)) are known as the [issuer identification number](https://en.wikipedia.org/wiki/Payment_card_number#Issuer_identification_number_(IIN))
* PAN — primary account number
#### Install
```bash
npm i @qiwi/card-info
yarn add @qiwi/card-info
```
#### Usage examples
```javascript
import BinlistnetService from '@qiwi/card-info/service/binlistnet'
const service = new BinlistnetService({...})
service.getPaymentSystem('4111111111111111') // Promise<'Visa'>
service.getPaymentSystem('1234') // Promise
```
##### `Promise` and `transport` customization
By default card-info uses native `Promise` and `fetch`. You may replace them with any compatible api. For example, `Bluebird` and `Axios`
```javascript
import cardInfo from '@qiwi/card-info'
import bluebird from 'bluebird'
import axios from 'axios'
cardInfo.Promise = bluebird
cardInfo.transport = axios // or any polyfill, pull-fetch-iso, etc.
```
#### Service configuration
Each service implementation has own supported opts list, but there is a common part:
| Option | Type | Default | Description |
| ------------- | ------- | ------------- | -------------------------------------------------------------------- |
| skipError | bool | true | means, that any fetch exception would be converted to null response |
| url | string | null | endpoint url |
| transport | Object | null | optional extras, merged to fetch arg.
For example, `{retries: [{delay: 100},{delay: 2000}}`|
##### Service composition
```javascript
import {composer} from '@qiwi/card-info'
import {PreService, BinlistnetService} from '@qiwi/card-info/service'
const preService = new PreService()
const binlistnetService = new BinlistnetService()
const composed = compose(preService, binlistnetService)
composed.getPaymentSystem('5321 4012 3456 7890') // 'Mastercard'
composed.getCardInfo('5321 4012 3456 7890') // if preService returns null, the request would be processed with binlist.net backend
```
#### `Braintree`
```javascript
import {BraintreeService} from '@qiwi/card-info/service'
const service = new BraintreeService({...})
service.getPaymentSystem('6759649826438453') // Promise<'Maestro'>
service.getPaymentSystem('1234') // Promise
```
Braintree's `credit-card-type` lib is exposed as static property of the class, so you're able to use its API. For example, add custom definitions:
```javascript
BraintreeService.creditCardType.addCard({
niceType: 'Foo',
type: 'foo',
prefixPattern: /^(12345)$/,
exactPattern: /^(12345)\d*$/,
gaps: [4, 8, 12],
lengths: [16],
code: {
name: 'CVV',
size: 3
}
})
const service = new BraintreeService()
service.getPaymentSystem('1234567890123456') // Promise<'FOO'>
```
##### `CustomService`
Composer supports any impl of [IService](./src/interface.js), so you're let to create your own class.
```javascript
import AbstractService from '@qiwi/card-info/service/abstract'
class CustomService extends AbstractService implements IService {
getPaymentSystem(pan: string): Promise {
// ...
}
getCardInfo(pan: string): Promise {
// ...
}
}
```
##### What's `PreService`
It's client-side implementation of service. The mostly used paysystems and bins are `hardcoded` for performance purposes.
##### Alternatives
* [braintree/credit-card-type](https://github.com/braintree/credit-card-type)
* [paylike/binlookup](https://github.com/paylike/binlookup)