Credit Card Type provides a useful utility method for determining a credit card type from both fully qualified and partial numbers. This is not a validation library but rather a smaller component to help you build your own validation or UI library.
This library is designed for type-as-you-go detection (supports partial numbers) and is written in CommonJS so you can use it in Node, io.js, and the browser.
To install via npm:
npm install credit-card-typeTo install via Bower:
bower install credit-card-typevar creditCardType = require('credit-card-type');
var visaCards = creditCardType('4111');
console.log(visaCards[0].type); // 'visa'
var ambiguousCards = creditCardType('6');
console.log(ambiguousCards.length); // 3
console.log(ambiguousCards[0].niceType); // 'Discover'
console.log(ambiguousCards[1].niceType); // 'UnionPay'
console.log(ambiguousCards[2].niceType); // 'Maestro'creditCardType will return an array of objects, each with the following data:
| Key | Type | Description |
|---|---|---|
niceType |
String |
A pretty printed representation of the card brand. - Visa- Mastercard- American Express- Diners Club- Discover- JCB- UnionPay- Maestro- Mir |
type |
String |
A code-friendly presentation of the card brand (useful to class names in CSS). Please refer to Card Type "Constants" below for the list of possible values. - visa- mastercard- american-express- diners-club- discover- jcb- unionpay- maestro- mir |
gaps |
Array |
The expected indeces of gaps in a string representation of the card number. For example, in a Visa card, 4111 1111 1111 1111, there are expected spaces in the 4th, 8th, and 12th positions. This is useful in setting your own formatting rules. |
lengths |
Array |
The expected lengths of the card number as an array of strings (excluding spaces and / characters). |
code |
Object |
The information regarding the security code for the determined card. Learn more about the code object below. |
If no card types are found, this returns an empty array.
getTypeInfo will return a singular object (with the same structure as creditCardType) corresponding with the specified type, or undefined if the specified type is invalid/unknown.
Named variables are provided for each of the supported card types:
VISAMASTERCARDAMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBUNIONPAYMAESTROMIR
Card brands provide different nomenclature for their security codes as well as varying lengths.
| Brand | Name | Size |
|---|---|---|
Visa |
CVV |
3 |
Mastercard |
CVC |
3 |
American Express |
CID |
4 |
Diners Club |
CVV |
3 |
Discover |
CID |
3 |
JCB |
CVV |
3 |
UnionPay |
CVN |
3 |
Maestro |
CVC |
3 |
Mir |
CVP |
3 |
A full response for a Visa card will look like this:
{
niceType: 'Visa',
type: 'visa',
gaps: [ 4, 8, 12 ],
lengths: [16],
code: { name: 'CVV', size: 3 }
}CommonJS:
var creditCardType = require('credit-card-type');
var getTypeInfo = require('credit-card-type').getTypeInfo;
var CardType = require('credit-card-type').types;ES6:
import creditCardType, { getTypeInfo, types as CardType } from 'credit-card-type';creditCardType(cardNumber).filter(function(card) {
return card.type == CardType.MASTERCARD || card.type == CardType.VISA;
});You can add additional card brands not supportted by the the module with addCard. Pass in the configuration object.
creditCardType.addCard({
niceType: 'NewCard',
type: 'new-card',
prefixPattern: /^(2|23|234)$/,
exactPattern: /^(2345)\d*$/,
gaps: [4, 8, 12],
lengths: [16],
code: {
name: 'CVV',
size: 3
}
});You can also modify existing cards:
creditCardType.addCard({
niceType: 'Visa with Custom Nice Type',
type: creditCardType.types.VISA,
prefixPattern: /^(4)$/,
exactPattern: /^(4[0-1])\d*$/, // restrict to only match visas that start with 40 or 41
gaps: [4, 8, 12],
lengths: [13, 16, 19], // add support for old, deprecated 13 digit visas
code: {
name: 'CVV',
size: 3
}
});The exactPattern regex is checked first. If that pattern is matched, the module takes that result over the prefixPattern. The prefixPattern is a softer matcher for when the exact card type has not yet been determined, so multiple card types may be returned.
As an example, by default, the Visa exactPattern matches any card number that starts with 4. If you are adding a card type that has a bin range that starts with 4, you will not only have to call addCard with the new card type, but addCard with Visa to alter the exactPattern and prefixPattern;
var visa = creditCardType.getTypeInfo(creditCardType.types.VISA);
visa.prefixPattern = /^(4)$/;
visa.exactPattern = /^(4[0-1])\d*$/; // restrict to only match visas that start with 40 or 41
creditCardType.addCard(visa);Adding new cards puts them at the bottom of the priority for testing. Priority is determined by an array. By default, the priority looks like:
[
creditCardType.types.VISA,
creditCardType.types.MASTERCARD,
creditCardType.types.AMERICAN_EXPRESS,
creditCardType.types.DINERS_CLUB,
creditCardType.types.DISCOVER,
creditCardType.types.JCB,
creditCardType.types.UNIONPAY,
creditCardType.types.MAESTRO,
creditCardType.types.MIR
]You can adjust the order using changeOrder. The number you pass in as the second argument is where the card is inserted into the array. The closer to the beginning of the array, the higher priority it has.
creditCardType.changeOrder('my-new-card', 0); // give custom card type the highest priority
creditCardType.changeOrder('my-new-card', 3); // give it a priority at position 3 in the test order arrayYou can also remove cards with removeCard.
creditCardType.removeCard(creditCardType.types.VISA);
If you need to reset the modifications you have created, simply call resetModifications:
creditCardType.resetModifications();function prettyCardNumber(cardNumber, cardType) {
var card = getTypeInfo(cardType);
if (card) {
var offsets = [].concat(0, card.gaps, cardNumber.length);
var components = [];
for (var i = 0; offsets[i] < cardNumber.length; i++) {
var start = offsets[i];
var end = Math.min(offsets[i + 1], cardNumber.length);
components.push(cardNumber.substring(start, end));
}
return components.join(' ');
}
return cardNumber;
}
prettyCardNumber('xxxxxxxxxx343', CardType.AMERICAN_EXPRESS); // 'xxxx xxxxxx 343'We use nvm for managing our node versions, but you do not have to. Replace any nvm references with the tool of your choice below.
nvm install
npm installAll testing dependencies will be installed upon npm install and the test suite executed with npm test.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent