VaultingElement

2026-04-17 09:24

Vaulting binding card element, used to collect the buyer's credit card/debit card information and complete the card binding process. Card binding refers to saving the buyer's payment method to the merchant system for quick payment later.

Note: VaultingElement is only responsible for rendering the card binding form and collecting information. The actual card binding submission requires calling antom.confirmCardSetup(), passing the VaultingElement instance as the elements parameter.

Method signature

When calling this method, please use the following standard method signature format.

JavaScript

TypeScript

copy
antom.createElement('vaulting', options)

Parameters

Parameter	Data type	Required	Description
elementType	String	Yes	Element type. In this scenario, pass in `vaulting`, used to collect the buyer's credit card/debit card information and complete the card binding process.
options	Object	No	A configuration object used to set the appearance theme and multilingual environment of components.

options

Parameter	Data type	Required	Description
sessionData	String	Yes	Card binding session data. Used to identify the current card binding session, this value is generated and returned by the merchant server.
locale	String	No	Multilingual configuration. Note: If the locale parameter is set in the `loadAntom()` method, the locale value in the `antom.createElement()` method takes precedence. Valid values are: `en_US`: Default value. English `pt_BR`: Portuguese (Brazil) `pt_PT`: Portuguese `es_ES`: Spanish `ko_KR`: Korean `zh_CN`: Simplified Chinese `zh_HK`: Traditional Chinese `ms_MY`: Malay `in_ID`: Indonesian `th_TH`: Thai `vi_VN`: Vietnamese `tl_PH`: Filipino `it_IT`: Italian `de_DE`: German `fr_FR`: French `nl_NL`: Dutch `ja_JP`: Japanese `ro`: Romanian `pl_PL`: Polish `ar_SA`: Arabic `tr_TR`: Turkish `hi_IN`: Hindi
appearance	Object	No	Used for custom appearance configuration. For more information, refer to Appearance customization. It contains the following parameters: theme: Theme color. variables: Override underlying CSS custom properties using CSS design tokens (e.g., `color-primary`) to implement theme customization.

Return value

This method returns a VaultingElement instance object, providing methods for mounting, unmounting, destroying, registering event listeners, and updating configuration:

Method name	Description
`element.on()`	Register event listeners for the Element instance.
`element.mount()`	Used to mount the Element to the DOM.
`element.destroy()`	Destroy the current Element (cannot be mounted again).
`element.unmount()`	Unmount the current Element (can be mounted again).
`element.updateConfig()`	Update the configuration of the Element.