ICard Interface

This interface contains all the methods to be used when resolving initCardToken().

Methods

METHOD	DESCRIPTION
focus	Focus on a server-side field.
getFormValidity	Validate all fields.
onFieldBlur	This event is emitted when the field loses focus.
onFieldFocus	This event is executed when the field is focused.
onFieldSubmit	This event is executed when the field has been submitted.
onFieldValidity	This event is executed when the validity of the field changes.
onOTPValidation	This event is triggered when OTP validation is required.
requestToken	Obtain a payment token with a card.
reset	Reset a server-side field.

focus

Focus on a server-side field.

This method asynchronously focuses on a form field of the specified type; otherwise, an exception will be generated.

Parameters

PARAMETER	TYPE	REQUIRED
`fieldType`	FieldTypeEnum	NO

Errors

CODE	MESSAGE	EXAMPLE	DESCRIPTION
E010	Error al realizar focus en el campo	{ code: "E010", message: "Error al realizar focus en el campo" }	If the specified field type is invalid, it will return an E010 error

Example

getFormValidity

This function returns a FormValidity representing the validation status of all fields.

Example

Validation of all server-side fields.

onFieldBlur

This event is emitted when the field loses focus.

Parameters

PARAMETER	TYPE	REQUIRED	DESCRIPTION
`event`	fieldEvent	YES	This callback is executed when the server-side field is blurry. fieldEvent: FieldValidity \| FormValidity
`fieldType`	FieldTypeEnum	NO	Set the field type if you want to control the event blurring of a specific server-side field

Examples

Management of blur events of all server-side fields.

Management of the blur event of a specific server-side field.

onFieldFocus

This event is executed when the field is focused.

Parameters

PARAMETER	TYPE	REQUIRED	DESCRIPTION
`event`	fieldEvent	YES	This callback is executed when the server-side field is focused. fieldEvent: FieldValidity \| FormValidity
`fieldType`	FieldTypeEnum	NO	Set the field type if you want to control the event focus of a specific server-side field

Examples

Management of the focus events of all server-side fields.

Management of the focus event of a specific server-side field.

onFieldSubmit

This event is executed when the field has been sent.

Parameters

PARAMETER	TYPE	REQUIRED	DESCRIPTION
`event`	fieldEvent	YES	This callback is executed when the server-side field is sent. fieldEvent: FieldValidity \| FormValidity
`fieldType`	FieldTypeEnum	NO	Set the field type if you want to control the event dispatch of a specific server-side field

Examples

Management of the submit events for all server-side fields.

Management of the submit event of a specific server-side field.

onFieldValidity

This event is executed when the field validation changes.

Parameters

PARAMETER	TYPE	REQUIRED	DESCRIPTION
`event`	fieldEvent	YES	This callback is executed when the server-side field changes its validity. fieldEvent: FieldValidity \| FormValidity
`fieldType`	FieldTypeEnum	NO	Set the field type if you want to control the validity of a specific server-side field event

Examples

Management of the validity events of all server-side fields.

Management of the validity event of a specific server-side field.

onOTPValidation

This event is executed when a value is entered in the OTP field to validate the code. OTP authentication requires a one-time password for enhanced security in online transactions. The user will have 3 attempts to enter a valid OTP; otherwise, the transaction will be rejected.

This validation will only be executed if the merchant has an OTP rule enabled, and the condition is met.

OTP validation is activated when the third digit is entered in the OTP field. It will activate each validation event, and you can capture these events using the onError or OnSuccess callbacks. .

Parameters

PARAMETER	TYPE	REQUIRED	DESCRIPTION
`onRequired`	callback	YES	This callback is executed when the created token needs OTP validation
`onError`	callback	YES	This callback is executed when the OTP validation returns an error
`onSuccess`	callback	YES	This callback is executed when OTP validation is successful

Errors

If the OTP validation is incorrect, the onError) callback will return the following error messages:

CODE	MESSAGE	EXAMPLE	DESCRIPTION
E008	OTP validation error	{ code: "E008", message: "Error en la validación de OTP" }	If the OTP validation is not correct, the `onError` callback will return the error code E008. Please try again by entering the correct data for the OTP validation.

Examples

Management of onOTPValidation events of the server-side field for OTP.

requestToken

Get a payment token with a card

This method validates if all fields are valid and obtains a payment token with a card; otherwise, it will throw an exception.

If the merchant has an OTP, 3DS, or SiftScience rule enabled, this method will automatically perform validations for each rule.

When the instance of the initCardToken method is configured as a subscription, the token must be used to create a subscription; otherwise, you can continue as usual with the flow for one-time payment.

This method returns an object of type TokenResponse with the generated token and in case there are deferrals they will be returned in the response.

Errors

The following is the list of errors that can be returned by the requestToken() method as a KushkiError object:

CODE	MESSAGE	EXAMPLE	DESCRIPTION
E002	Error en solicitud de token (Error in token request)	{ code: "E002", message: "Error en solicitud de token" }	If there was an error when requesting a token, the error code E002 will be returned. Please validate that the required information has been submitted correctly.
E003	Error en solicitud de datos del comercio (Error in requesting merchant data )	{ code: "E003", message: "Error en solicitud de datos del comercio" }	If there was an error requesting the merchant information. Please try again if the error persists contact Kushki support.
E004	Error en solicitud de JWT ( Error in JWT request )	{ code: "E004", message: "Error en solicitud de JWT" }	If the merchant has a 3DS rule enabled and there was an error requesting the JWT. Please try again if the error persists contact Kushki support
E005	Campos 3DS inválidos ( Invalid 3DS fields)	{ code: "E005", message: "Campos 3DS inválidos" }	If the merchant has a 3DS rule enabled and there was an error in the 3DS authentication. Please try again making sure to enter the data correctly for the 3DS validation.
E006	Error en solicitud de validación de token ( Error in token validation request)	{ code: "E006", message: "Error en solicitud de validación de token" }	If the merchant has a 3DS rule enabled and there was an error in the 3DS validation session. Please try again making sure to enter correctly the data for the 3DS validation, if the error persists contact Kushki support
E007	Error en la validación del formulario (Error in form validation)	{ code: "E007", message: "Error en la validación del formulario" }	If any server-side field is invalid the error code E007 will be returned. Please try again making sure to enter the requested data correctly.
E008	Error en la validación de OTP (OTP validation error)	{ code: "E008", message: "Error en la validación de OTP" }	If the OTP validation is not successful, the onError callback will return the error code E008. Please try again by entering the correct data for the OTP validation

Examples

One-time payment or subscription

One-time payment or or deferred subscription

reset

Reset a server-side field.

This method asynchronously resets a field in the form of the specified type to its default state; otherwise, it will throw an exception.

Parameters

PARAMETER	TYPE	REQUIRED	DESCRIPTION
fieldType	FieldTypeEnum	NO	Set the field type if you want to control the event validity of a specific server-side field event

Errors

CODE	MESSAGE	EXAMPLE	DESCRIPTION
E009	Error al limpiar el campo	{ code: "E009", message: "Error al limpiar el campo" }	If the specified field type is invalid, the onError callback will return the error code E009.

ICard Interface

ICard Interface#

Methods#

focus#

Parameters#

Errors#

Example#

getFormValidity#

Example#

onFieldBlur#

Parameters#

Examples#

onFieldFocus#

Parameters#

Examples#

onFieldSubmit#

Parameters#

Examples#

onFieldValidity#

Parameters#

Examples#

onOTPValidation#

Parameters#

Errors#

Examples#

requestToken#

Errors#

Examples#

reset#

Parameters#

Errors#

Example#

ICard Interface

Methods

focus

Parameters

Errors

Example

getFormValidity

Example

onFieldBlur

Parameters

Examples

onFieldFocus

Parameters

Examples

onFieldSubmit

Parameters

Examples

onFieldValidity

Parameters

Examples

onOTPValidation

Parameters

Errors

Examples

requestToken

Errors

Examples

reset

Parameters

Errors

Example