Illustration of credit cards

creditcard.js

A simple credit card validation library in JavaScript

Install


Creditcard.js is available as a NPM package. You can install through Yarn or NPM:

Yarn

        
  yarn add creditcard.js

NPM

        
  npm install creditcard.js

Usage


  import { 
    isValid, 
    isExpirationDateValid, 
    isSecurityCodeValid, 
    getCreditCardNameByNumber 
  } from 'creditcard.js';
  
  isValid('4916108926268679'); // returns true
  isExpirationDateValid('02', '2027'); // returns true
  isSecurityCodeValid('4556603578296676', '250'); // returns true
  getCreditCardNameByNumber('4539578763621486'); // returns 'Visa'

Methods

isValid(number) ⇒ boolean

Checks whether the credit card number format is valid. (See the full list of currently supported cards)

  • number
    Required
    Type: string

isExpirationDateValid(month, year) ⇒ boolean

Checks that the expiration date is valid and not expired. (2 or 4 digit years are accepted)

  • month
    Required
    Type: string
  • year
    Required
    Type: string

isSecurityCodeValid(creditCardNumber, securityCode) ⇒ boolean

Check that the security code is valid according to the type of credit card.

  • creditCardNumber
    Required
    Type: string
  • securityCode
    Required
    Type: string

getCreditCardNameByNumber(number) ⇒ string

Returns the credit card type from the card number. (See the full list of currently supported cards)

  • number
    Required
    Type: string

Supported credit card types

  • American Express
  • Aura
  • Banescard
  • Cabal
  • Diners
  • Discover
  • Elo
  • Goodcard
  • Hipercard
  • Mastercard
  • Maxxvan
  • Visa

License


MIT © ContaAzul