wallet (XML resource)

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

Includes the following properties, depending on if it is for Apple Pay on the web or Visa Checkout:

Apple Pay

Request - Create Wallet

Property NameTypeRequiredDescription
wallet-typestringRequiredWallet Type.
Value must be APPLE_PAY.
validation-urlstringRequiredThe 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-namestringOptionalThe 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.

Visa Checkout

Request - Create Wallet

Property NameTypeRequiredDescription
wallet-typestringRequiredWallet type.
Value must be VISA_CHECKOUT.
store-idlongRequired
Extended Payment API only
Merchant’s store ID.
Relevant only for the Extended Payment API.
call-idstringRequiredThe ID returned from Visa Checkout on success event.
See Implementing Visa Checkout.

###Response - Create Wallet
Property NameTypeDescription
wallet-idlongID associated with this wallet resource.
first-namestringShopper's first name.
last-namestringShopper's last name.
emailstringShopper's email.
countrystringShopper's country code.
See Country codes.
phonestringShopper's phone number.
credit-cardcontainerContains credit-card properties.
billing-contact-infocontainerContainer of billing-contact-info properties.
shipping-contact-infocontainerContainer of shipping-contact-info properties.

###Response - Retrieve Wallet
Property NameTypeDescription
first-namestringShopper's first name.
last-namestringShopper's last name.
emailstringShopper's email.
countrystringShopper's country code.
See Country codes.
phonestringShopper's phone number.
credit-cardcontainerContainer of credit-card properties.
billing-contact-infocontainerContainer of billing-contact-info properties.
shipping-contact-infocontainerContainer of shipping-contact-info properties.