wallet (JSON object)

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

walletType

string

Required

Wallet type. Value must be APPLE_PAY.

validationUrl

string

Required

The URL used to validate the merchant's server.

Value is extracted from event.validationURL. See Apple Pay Guide.

domainName

string

Required

Merchant's registered domain.

displayName

string

Optional

The name displayed on Touch Bar of newer Macs.

Maximum 64 characters.


###Request - Onboard Apple Pay

Property Name

Type

Required

Description

walletType

string

Required

Wallet type. Value must be APPLE_PAY.

applePay

object

Required

Object containing:

  • domains   array  Required    Contains the domain names that will display the Apple Pay button (e.g. ["merchant.com", "bluesnap.com"]).

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


### Request - Update Apple Pay Onboarding Information

Property Name

Type

Required

Description

walletType

string

Required

Wallet type. Value must be APPLE_PAY.

applePay

object

Required

Object containing:

  • domains   array  Optional    Contains the names of the domains to register.
  • unregisterDomains   array  Optional    Contains the names of the domains to unregister.

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


###Response - Create Wallet

Property Name

Type

Description

walletType

string

Wallet type.

walletToken

string

Token for the wallet.


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

Property Name

Type

Description

walletType

string

Wallet type.

applePay

object

Object containing:

  • domains   array  Contains the domain names that will display the Apple Pay button (e.g. ["merchant.com", "bluesnap.com"]).

Visa Checkout

Request - Create Wallet

Property Name

Type

Required

Description

walletType

string

Required

Wallet type. Value must be VISA_CHECKOUT.

callId

string

Required

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


###Response - Create Wallet

Property Name

Type

Description

walletId

long

ID associated with this wallet resource.

firstName

string

Shopper's first name.

lastName

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.

creditCard

object

Contains creditCard properties.

billingContactInfo

object

Container of billingContactInfo properties.

shippingContactInfo

object

Container of shippingContactInfo properties.


###Response - Retrieve Wallet

Property Name

Type

Description

firstName

string

Shopper's first name.

lastName

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.

creditCard

object

Container of creditCard properties.

billingContactInfo

object

Container of billingContactInfo properties.

shippingContactInfo

object

Container of shippingContactInfo properties.