wallet (XML resource)

Contains information needed to launch a wallet payment page and returns the shopper details from the wallet.

Includes the following properties:

Apple Pay

Request - Create Wallet

Property NameTypeRequiredDescription
wallet-typestringRequiredWallet Type.
Value must be APPLE_PAY.
validation-urlstringRequired

The URL used to validate the merchant's server.

Value is extracted from Apple Pay JS. See Apple Pay Guide.

domain-namestringRequiredMerchant's registered domain.
display-namestringOptional

The name displayed on Touch Bar of newer Macs.

Maximum 64 characters.

Request - Onboard Apple Pay

Property NameTypeRequiredDescription
wallet-typestringRequiredWallet type.
Value must be APPLE_PAY.
apple-paycontainerRequiredContains:
  • domain  string  Required  Name of the domain that will display the Apple Pay button.
Notes:
  • Request may have more than one domain property.

  • Do not include https://

Request - Update Apple Pay Onboarding Information

wallet-typestringRequiredWallet type.
Value must be APPLE_PAY.
apple-paycontainerRequiredContains:
  • domain  string  Optional  Name of the domain to register.

  • unregister-domain  string  Optional  Name of the domain to unregister

Note: Do not include https:// in the domain name

Response - Create Wallet

Property NameTypeDescription
wallet-typestringWallet type.
wallet-tokenstringToken for the wallet.

Response - Update & Retrieve Apple Pay Onboarding Information

Property NameTypeDescription
wallet-typestringWallet type.
apple-paycontainerContains:
  • domain  string  Name of the domain that will display the Apple Pay button.