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 Name

Type

Required

Description

wallet-type

string

Required

Wallet Type. Value must be APPLE_PAY.

validation-url

string

Required

The URL used to validate the merchant's server.

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

domain-name

string

Required

Merchant's registered domain.

display-name

string

Optional

The name displayed on Touch Bar of newer Macs.

Maximum 64 characters.


###Request - Onboard Apple Pay

Property Name

Type

Required

Description

wallet-type

string

Required

Wallet type. Value must be APPLE_PAY.

apple-pay

container

Required

Contains:

  • 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-type

string

Required

Wallet type. Value must be APPLE_PAY.

apple-pay

container

Required

Contains:

  • 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 Name

Type

Description

wallet-type

string

Wallet type.

wallet-token

string

Token for the wallet.


###Response - Update & Retrieve Apple Pay Onboarding Information

Property Name

Type

Description

wallet-type

string

Wallet type.

apple-pay

container

Contains:

  • domain  string  Name of the domain that will display the Apple Pay button.

Visa Checkout

Request - Create Wallet

Property Name

Type

Required

Description

wallet-type

string

Required

Wallet type. Value must be VISA_CHECKOUT.

store-id

long

Required Extended Payment API only

Merchant’s store ID. Relevant only for the Extended Payment API.

call-id

string

Required

The ID returned from Visa Checkout on success event. See Implementing Visa Checkout.


###Response - Create Wallet

Property Name

Type

Description

wallet-id

long

ID associated with this wallet resource.

first-name

string

Shopper's first name.

last-name

string

Shopper's last name.

email

string

Shopper's email.

country

string

Shopper's country code. See Country codes.

phone

string

Shopper's phone number.

credit-card

container

Contains credit-card properties.

billing-contact-info

container

Container of billing-contact-info properties.

shipping-contact-info

container

Container of shipping-contact-info properties.


###Response - Retrieve Wallet

Property Name

Type

Description

first-name

string

Shopper's first name.

last-name

string

Shopper's last name.

email

string

Shopper's email.

country

string

Shopper's country code. See Country codes.

phone

string

Shopper's phone number.

credit-card

container

Container of credit-card properties.

billing-contact-info

container

Container of billing-contact-info properties.

shipping-contact-info

container

Container of shipping-contact-info properties.