Interface ICardPayouts

Focus a hosted field

This method asynchronously focus a form field of the specified type, otherwise it will throw an exception

Throws

• if error occurred on focus ERRORS.E010

Example

// Basic example
try {
   await cardPayouts.focus(FieldTypeEnum.cardholderName);
   // On Success, can focus field
 } catch (error: any) {
     // On Error, catch response, ex. {code:"E010", message: "Error al realizar focus en el campo"}
     console.error("Catch error on focus field", error.code, error.message);
 }
Copy

This function returns an FormValidity that represents the validation state of all fields

Example

Get field validity of cvv field

    const event: FormValidity = cardPayouts.getFormValidity()
    // On Success, can get FormValidity, ex. FormValidity: { isFormValid: true, triggeredBy: cardNumber, fields: Fields}
    // Implement your logic to handle the event , here
    if (event.isFormValid) {
       console.log("Form valid", event);
    } else {
       console.log("Form invalid", event);
    }
Copy

This event is emitted when some field loses focus

Example

Handling events 'blur' to get FormValidity

try {
     cardPayouts.onFieldBlur((event: FormValidity) => {
       // Implement your logic to handle the event FormValidity here
       if (event.fields[event.triggeredBy].isValid) {
         console.log("Form valid", event);
       } else {
         console.log("Form invalid", event);
       }
     });
   // On Success, can get onFieldBlur, ex. FormValidity: { isFormValid: true, triggeredBy: isSubscription, fields: Fields}
 } catch (error: any) {
     console.error("Catch error on onFieldBlur", error.code, error.message);
 }
Copy

Handling event 'blur' to get specific FieldValidity

try {
    cardPayouts.onFieldBlur((event: FieldValidity) => {
       if (event.isValid) {
         console.log("Form field is valid", event);
       } else {
         console.log("Form field is invalid", event);
         console.log("this is error", event.errorType);
       }
     }, FieldTypeEnum.isSubscription);
   // On Success, can get onFieldBlur, ex. FieldValidity : { isValid: false, errorType: "empty"}
 } catch (error: any) {
     console.error("Catch error on onFieldBlur", error.code, error.message);
 }
Copy

This event is emitted when some field gains focus

Example

Handling events 'focus' to get FormValidity

try {
     cardPayouts.onFieldFocus((event: FormValidity) => {
       // Implement your logic to handle the event FormValidity here
       if (event.fields[event.triggeredBy].isValid) {
         console.log("Form valid", event);
       } else {
         console.log("Form invalid", event);
       }
     });
   // On Success, can get onFieldFocus, ex. FormValidity: { isFormValid: true, triggeredBy: cardHolderName, fields: Fields}
 } catch (error: any) {
     console.error("Catch error on onFieldFocus", error.code, error.message);
 }
Copy

Handling event 'focus' to get specific hosted field FieldValidity

try {
    cardPayouts.onFieldFocus((event: FieldValidity) => {
       if (event.isValid) {
         console.log("Form field is valid", event);
       } else {
         console.log("Form field is invalid", event);
         console.log("this is error", event.errorType);
       }
     }, FieldTypeEnum.cardHolderName);
   // On Success, can get onFieldFocus, ex. FieldValidity : { isValid: false, errorType: "empty"}
 } catch (error: any) {
     console.error("Catch error on onFieldFocus", error.code, error.message);
 }
Copy

This event is emitted when some field has submitted.

Example

Handling events 'submit' to get FormValidity

try {
     cardPayouts.onFieldSubmit((event: FormValidity) => {
       // Implement your logic to handle the event FormValidity here
       if (event.fields[event.triggeredBy].isValid) {
         console.log("Form valid", event);
       } else {
         console.log("Form invalid", event);
       }
     });
   // On Success, can get onFieldSubmit, ex. FormValidity: { isFormValid: true, triggeredBy: cardNumber, fields: Fields}
 } catch (error: any) {
     console.error("Catch error on onFieldSubmit", error.code, error.message);
 }
Copy

Handling event 'submit' to get FieldValidity of specific field

try {
    cardPayouts.onFieldSubmit((event: FieldValidity) => {
       if (event.isValid) {
         console.log("Form field is valid", event);
       } else {
         console.log("Form field is invalid", event);
         console.log("this is error", event.errorType);
       }
     }, FieldTypeEnum.cardNumber);
   // On Success, can get onFieldSubmit, ex. FieldValidity : { isValid: false, errorType: "empty"}
 } catch (error: any) {
     console.error("Catch error on onFieldSubmit", error.code, error.message);
 }
Copy

This event is emitted when the field validity changes

Example

Handling events 'FormValidity' of all hosted fields

try {
     cardPayouts.onFieldValidity((event: FormValidity) => {
       // Implement your logic to handle the event FormValidity here
       if (event.fields[event.triggeredBy].isValid) {
         console.log("Form valid", event);
       } else {
         console.log("Form invalid", event);
       }
     });
   // On Success, can get FormValidity, ex. FormValidity: { isFormValid: true, triggeredBy: cardNumber, fields: Fields}
 } catch (error: any) {
     console.error("Catch error on onFieldValidity", error.code, error.message);
 }
Copy

Handling event 'FieldValidity' of cardNumber field

try {
    cardPayouts.onFieldValidity((event: FieldValidity) => {
       if (event.isValid) {
         console.log("Form field is valid", event);
       } else {
         console.log("Form field is invalid", event);
         console.log("this is error", event.errorType);
       }
     }, FieldTypeEnum.cardNumber);
   // On Success, can get onFieldValidity, ex. FieldValidity : { isValid: false, errorType: "empty"}
 } catch (error: any) {
     console.error("Catch error on onFieldValidity", error.code, error.message);
 }
Copy

Get a secure token or subscriptionId for card payouts transaction

This method validates if all fields are valid and obtains a card payout token or subscriptionId, otherwise it will throw an exception

Throws

KushkiErrorResponse object with code and message of error

• if error on request payout token endpoint then throw ERRORS.E002
• if any hosted field is invalid, then throw ERRORS.E007

Example

// Example for one-time token
// In this case the isSubscription is unchecked or is not rendered with empty isSubscription config

try {
   const token: CardPayoutTokenResponse = await cardPayouts.requestCardPayoutToken();
   // On Success, can get one-time token response, ex. {token: "a2b74b7e3cf24e368a20380f16844d16", maskedPan: "5102********9913", brand: "MASTERCARD"}
   console.log("This is the Token", tokenResponse.token)
 } catch (error: any) {
     // On Error, catch response, ex. {code:"E002", message: "Error en solicitud de token"}
     // On Error, catch response, ex. {code:"E007", message: "Error en la validación del formulario"}
     console.error("Catch error on request device Token", error.code, error.message);
 }
Copy

Example

// Example for subscriptionId token
// In this case the isSubscription is checked

try {
   const token: CardPayoutTokenResponse = await cardPayouts.requestCardPayoutToken();
   // On Success, can get subscriptionId response, ex. {subscriptionId: "9750386377a9429ba945e8a68e6d3a23", maskedPan: "4242********4242", brand: "VISA"}
   console.log("This is the subscriptionId", tokenResponse.subscriptionId)
 } catch (error: any) {
     // On Error, catch response, ex. {code:"E002", message: "Error en solicitud de token"}
     // On Error, catch response, ex. {code:"E007", message: "Error en la validación del formulario"}
     console.error("Catch error on request device Token", error.code, error.message);
 }
Copy

Reset hosted field

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

Throws

• if error occurred on reset ERRORS.E009

Example

// Basic example
try {
   await cardPayouts.reset(FieldTypeEnum.cardholderName);
   // On Success, can reset field
 } catch (error: any) {
     // On Error, catch response, ex. {code:"E009", message: "Error al limpiar el campo"}
     console.error("Catch error on reset field", error.code, error.message);
 }
Copy