Factories
Shared options
Both wallets extend the same base:
The wallet sheet owns its own validity and submits directly on the shopper’s tap.
WalletTransactionOptions
WalletRequireOptions
true value asks the sheet to collect that field. The wallet returns collected values in the WalletElementValue payload.
Apple Pay-specific options
ApplePayRequirementOptions
requiredBillingContactFields or requiredShippingContactFields is set, it fully replaces the array derived from require. Use this as an escape hatch for fields not covered by require (e.g. phoneticName).
Google Pay-specific options
GooglePayRequirementOptions
Value
walletToken and walletType (plus any optional contact or address fields the sheet returned) to your server to authorize the charge.
onClick gate
Wallet onClick handlers receive a gate event, not a boolean-returning callback. Call event.preventDefault() first, then either event.resolve() to open the sheet or event.reject(error) to cancel.
Events
Wallets emitonReady, onChange, onSubmit, onError, onFocus, onBlur, onClick, and onExit. onEscapeKeyPressed is not emitted from wallets (the sheet owns escape handling).
Methods
wallet.mount(selector)wallet.update(partialOptions)wallet.unmount()wallet.destroy()wallet.on(event, handler)
.submit(). The wallet button is the submit action.