Create Transfer Element
createElement('payoutForm', options?)
Use this function to create an instance of an individual Element.
Parameters
The type of element you are creating.
Options for creating payoutForm Element.
Returns
PayoutFormElement | null
TypeScript1import { createElement } from '@airwallex/components-sdk';2const element = await createElement('payoutForm', {3 defaultValues: {4 beneficiary_id: 'replace-with-your-beneficiary-id',5 },6});
PayoutFormElementOptions
Options for creating the Payout Form Element.
The Airwallex API version to use for the form. Only support for api version after 2023-04-15.
Customization options for the form's behavior and appearance.
Pre-filled values for the form fields. Note: Pre-filled values only take effect for fields that can be rendered on initial load. Fields that are dynamically generated through user interactions will not be affected by default values.
The locale for the Element, applied to Element UI strings and error messages. By default, the locale configured in init() is used.
PayoutFormElement
Functions and external fields can be used in your integration flow with Payout Form element.
mount(domElement)
Mounts Element to your HTML DOM.
Parameters
The container DOM element to mount the element.
Returns
voidTypeScript1// There are two ways to mount the element:2// 1. Call with the container DOM id3element.mount('container-dom-id');45// 2. Find the created DOM in the existing HTML and call with the container DOM element6const containerElement = document.getElementById('container-dom-id');7element.mount(containerElement);
on(eventCode, handler)
Listen to the Element events.
Parameters
The event code to listen for.
The callback function that will be called when the event occurs.
Returns
voidTypeScript1element.on('ready', () => {2 // The 'ready' event indicates that the form is ready for user interaction3 // This event can be used to hide loading indicators4 // For a complete list of event codes, please refer to the PayoutFormEventCode enum5});
