Skip to main content

SdkAdapterEventData

Properties​

ready​

ready: void;

Triggered when the provider vaultSDK has been loaded and is ready to use.

success​

success: object;

Triggered when the submission has been successful

vault_form_token​

vault_form_token: string;

card?​

optional card: CardInfo;

Returns​

The vault_form_token is the identifier for the vault form, and card contains information about the card such as the masked bin, the last digit and the detected brands.

error​

error: object;

Triggered for multiple errors while using the SDK.

message​

message: string;

code?​

optional code: string;

payload?​

optional payload: any;

formValid​

formValid: object;

Triggered when the form validation changes. It's fired once at initialization with false and then on every change.

hasErrors​

hasErrors: boolean;

fields?​

optional fields: FieldsState;

focus​

focus: object & FieldState & object;

Triggered when a field is focused This include the state of the field on which the change happened but also the state of the other fields.

Type Declaration​

fieldName​
fieldName: string;

Type Declaration​

fields​
fields: FieldsState;

blur​

blur: object & FieldState & object;

Triggered when a field is blurred/unfocused This include the state of the field on which the change happened but also the state of the other fields.

Type Declaration​

fieldName​
fieldName: string;

Type Declaration​

fields​
fields: FieldsState;

autocomplete​

autocomplete: object & FieldState & object;

Triggered when a field is autocompleted This include the state of the field on which the change happened but also the state of the other fields.

Type Declaration​

fieldName​
fieldName: string;

Type Declaration​

fields​
fields: FieldsState;

keyup​

keyup: object & FieldState & object;

Triggered when a key is pressed in a field This include the state of the field on which the change happened but also the state of the other fields.

Type Declaration​

fieldName​
fieldName: string;

Type Declaration​

fields​
fields: FieldsState;

keydown​

keydown: object & FieldState & object;

Triggered when a key is pressed down in a field This include the state of the field on which the change happened but also the state of the other fields.

Type Declaration​

fieldName​
fieldName: string;

Type Declaration​

fields​
fields: FieldsState;

change​

change: object & FieldState & object;

Triggered when a field changes(focus, blur, keyup, keydown, autocomplete). This include the state of the field on which the change happened but also the state of the other fields.

Type Declaration​

fieldName​
fieldName: string;

Type Declaration​

fields​
fields: FieldsState;

cardInfo​

cardInfo: CardInfo;

Triggered when the card information is available. This include the detected brands, the masked bin and the last four digits of the card.

brandDetected​

brandDetected: object;

Triggered when a brand is detected in the card number field. It can also contain a co-brand if applicable.

brands?​

optional brands: (
  | "VISA"
  | "CARTE_BANCAIRE"
  | "MASTERCARD"
  | "MAESTRO"
  | "AMERICAN_EXPRESS"
  | "DISCOVER"
  | "JCB"
  | "DINERS_CLUB"
  | "UNIONPAY"
  | "OTHER")[];