Versions Compared

Version Old Version 5 New Version 6
Changes made by

Kyle Robinson

Kyle Robinson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

type

'validation' | 'tokenization' | 'cardType'

the type of message

fieldName

'cardNumber' | 'cardCvv' | 'cardExpiry'

 

success

boolean

result of an action. Eg validation or tokenization

message

string

Optional. Eg for validation, might include a validation error string.

paymentToken

string

The same paymentToken to be used in the sale API.

cardTypeData

CardTypeData

Only applies if the type is `cardType`

CardTypeData

This is only useful for receiving the detected card type from the user:

Code Block
languagejs
typeData?: {
    niceType: string;      // Human-readable card type (e.g., "Visa")
    type: string;          // Card type code
    patterns: number[] | [number[]];  // Valid number patterns
    gaps: number[];        // Positions of gaps in card number
    lengths: number[];     // Valid card number lengths
    code: {
        size: number;      // CVV length
        name: string;      // CVV field name (e.g., "CVV")
    };
    matchStrength?: number; // Confidence of card type match
};

type strings

Code Block
  | "american-express"
  | "diners-club"
  | "discover"
  | "elo"
  | "hiper"
  | "hipercard"
  | "jcb"
  | "maestro"
  | "mastercard"
  | "mir"
  | "unionpay"
  | "visa";

...