Airwallex LogoAirwallex Logo
Airwallex LogoAirwallex Logo

Create Card CVC Element

createElement('cvc', options?)

Use this function to create an instance of an individual Element.

Parameters

typerequired'cvc'

The type of element you are creating.

optionsoptionalCvcElementOptions

Options for creating cvc Element.

Returns

CvcElement | null

createElement('cvc', options?)

npm

1import { init, createElement } from '@airwallex/components-sdk';
2
3await init({
4 env: 'prod',
5 enabledElements: ['payments'],
6});
7
8const element = await createElement('cvc');
9
10element.mount('cvc-container');

CvcElementOptions

Applies to split card element type integration, the interface used when createElement() called with type cvc.

authFormContaineroptionalstring

The container id of the authentication form used in 3D Secure authentication.

cvcLengthoptionalnumber

Indicate CVC length.

disabledoptionalboolean

Whether the CVC Element input is disabled or not. Default value is false.

isMaskedoptionalboolean

Whether the CVC input is masked Default value is false.

isStandaloneoptionalboolean

Whether CVC Element works alone or not. If you want to use the CVC Element for a saved Payment Consent, you could set it true to improve the checkout experience.

placeholderoptionalstring

A short hint to suggest the expected value of an input field to the shopper.

styleoptional

Style for the CVC Element.

CvcElement

Element functions can be used in your integration flow with Airwallex element.

blur()

Using this function to blur the HTML Input element.

Returns

void

blur()

1element.blur();

clear()

Using this function to clear the HTML Input element.

Returns

void

clear()

1element.clear();

confirm(data)

Call this function when the shopper is ready to make a payment as per the details in the Payment Intent.

Returns

Promiselink<>

confirm(data)

1element.confirm({
2 client_secret: 'replace-with-your-client-secret',
3});

createPaymentConsent(data)

Call this function to create a Payment Consent, which represents the agreement between the merchant and shopper of making subsequent payments using the provided payment method.

Returns

Promiselink<>

createPaymentConsent(data)

1element.createPaymentConsent({
2 client_secret: 'replace-with-your-client-secret',
3});

destroy()

Destroys the Element instance.

Returns

void

destroy()

1element.destroy();

focus()

Using this function to focus the HTML Input element.

Returns

void

focus()

1element.focus();

mount(domElement)

Mounts Element to your HTML DOM.

Parameters

domElementrequiredstring | HTMLElement

Returns

null | HTMLElement

mount(domElement)

1// There are two ways to mount the element:
2// 1. Call with the container DOM id
3element.mount('container-dom-id');
4
5// 2. Find the created DOM in the existing HTML and call with the container DOM element
6const containerElement = document.getElementById('container-dom-id');
7element.mount(containerElement);

on(eventCode, handler)

Listen to Element events.

Type Parameters

A generic type for event codes. Ideally, you don't need to specify this explicitly as it can be inferred automatically.

Parameters

The event code to listen for.

The callback function that will be called when the event occurs.

Returns

void

on(eventCode, handler)

1element.on('change', (e) => {
2 const { completed, empty, error } = e.detail;
3 // Handle change event
4});

unmount()

Unmounts the Element. Note that the Element instance will remain.

Returns

void

unmount()

1element.unmount();

update(options?, initOptions?)

Call this function to update Element options after creating the Element.

Returns

void

update(options?, initOptions?)

1element.update({
2 placeholder: 'replace-with-your-placeholder',
3});

Was this page helpful?