Skip to main content

Factories

Shared options

Both wallets extend the same base:

WalletTransactionOptions

Amounts are minor units. Every supported wallet currency uses 2 decimals.

WalletRequireOptions

Each true value asks the sheet to collect that field.

Provider mapping

Apple Pay-specific options

ApplePayRequirementOptions

When either 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

Events

Wallets emit onReady, 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)
Wallets do not expose .submit(). The wallet button is the submit action.
Last modified on July 22, 2026