Whether inside event data, or as an argument passed to a supplied callback, the data structure will always arrive in this format:
{ type: 'validation', fieldName: 'cardNumber' | 'cardCvv' | 'cardExpiry', success: boolean, message: string, paymentToken: string }
| ‘validation’ | ‘tokenization’ | ‘cardType’ | the type of message |
---|---|---|
|
|
|
| boolean | result of an action. Eg validation or tokenization |
| string | Optional. Eg for validation, might include a validation error string. |
| string | The same paymentToken to be used in the sale API. |
| CardTypeData | Only applies if the type is `cardType` |
CardTypeData
This is only useful for receiving the detected card type from the user:
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 };