initCardPayoutToken

Introduction

Initializes an instance of ICardPayouts.

Parameters

kushkiInstance: IKushki
An object that implements IKushki.

options: CardPayoutOptions

You must define setup of card payout fields

Payment Type (optional): Defines the payment type. Default value is undefined. Maximum length: 2.

Example: example here.

Prevent Autofill (optional): Prevents autofilling fields. Default value is false.

Example: example here.

Set Custom Fields: Allows customization of specific fields.

Example: example here.

Set Custom Styles: Enables custom styling for the fields.

Example: example here.

Returns

Promise - instance of ICardPayouts.

Throws

If the options or kushkiInstance parameters are null or undefined, the ERRORS.E012 error is thrown.

If the options.paymentType property has an invalid length, the ERRORS.E011 error is thrown.

If any field within options.fields has a non-existent selector, the ERRORS.E013 error is thrown.

If options.fields does not contain the required fields for the card payout token, the ERRORS.E020 error is thrown.

Examples

Basic Card Payout Token

Define the containers for the hosted fields

Initialize Card Payout Token Instance

In the background, this method renders the hosted fields.

Card Payout Token with Required `isSubscription`

Configuration for Required `isSubscription` Field

To specify whether the isSubscription hosted field is required, add the isRequired flag to the isSubscription configuration. The default value is false.

If the isSubscription field is required, when calling the requestToken method, the isSubscription checkbox must be checked. Otherwise, an error will be thrown.

If the isSubscription field is not required, selecting the isSubscription checkbox is optional.

Card Payout Token with `isSubscription` Field Omitted

Configuration for Omitted `isSubscription` Field

To omit the isSubscription hosted field, simply remove its configuration.

If the isSubscription configuration is missing, the isSubscription checkbox will not be rendered on the page.

The default value for the isSubscription checkbox is false.

Options Example

Use the same custom styling methodology as Card Token Styles, but apply the styles to the payout hosted fields.

The preventAutofill flag can be used to enable or disable autofill using the browser’s stored data.

The paymentType value is sent in the token request and must contain only two characters.

For Visa and Mastercard, the accepted value for paymentType is "GP". For other brands, refer to the allowed values list.

Introduction#

Parameters#

Returns#

Throws#

Examples#

Basic Card Payout Token#

Define the containers for the hosted fields#

Initialize Card Payout Token Instance#

Card Payout Token with Required isSubscription#

Configuration for Required isSubscription Field#

Card Payout Token with isSubscription Field Omitted#

Configuration for Omitted isSubscription Field#

Options Example#

Introduction

Parameters

Returns

Throws

Examples

Basic Card Payout Token

Define the containers for the hosted fields

Initialize Card Payout Token Instance

Card Payout Token with Required `isSubscription`

Configuration for Required `isSubscription` Field

Card Payout Token with `isSubscription` Field Omitted

Configuration for Omitted `isSubscription` Field

Options Example