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 whether it is for Apple Pay on the web or Visa Checkout:\

{`

`}

Apple Pay

Request - Create Wallet

  <th>
    Type
  </th>

  <th>
    Required
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    Wallet Type.\
    Value must be **APPLE\_PAY**.
  </td>
</tr>

<tr>
  <td>
    `validation-url`
  </td>

  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    The URL used to validate the merchant's server.

    Value is extracted from Apple Pay JS. See [Apple Pay Guide](/docs/apple-pay#section-step-4-set-up-the-onvalidatemerchant-callback).
  </td>
</tr>

<tr>
  <td>
    `domain-name`
  </td>

  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    Merchant's [registered domain](/docs/apple-pay#section-step-1-verify-your-domain).
  </td>
</tr>

<tr>
  <td>
    `display-name`
  </td>

  <td>
    *string*
  </td>

  <td>
    Optional
  </td>

  <td>
    The name displayed on Touch Bar of newer Macs. 

    Maximum 64 characters.
  </td>
</tr>
Property Name
`wallet-type`

###Request - Onboard Apple Pay
  <th>
    Type
  </th>

  <th>
    Required
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    Wallet type.\
    Value must be **APPLE\_PAY**.
  </td>
</tr>

<tr>
  <td>
    `apple-pay`
  </td>

  <td>
    *container*
  </td>

  <td>
    **Required**
  </td>

  <td>
    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://`
  </td>
</tr>
Property Name
`wallet-type`

### Request - Update Apple Pay Onboarding Information
  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    Wallet type.\
    Value must be **APPLE\_PAY**.
  </td>
</tr>

<tr>
  <td>
    `apple-pay`
  </td>

  <td>
    *container*
  </td>

  <td>
    **Required**
  </td>

  <td>
    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
  </td>
</tr>
  </th>

  <th>

  </th>

  <th>

  </th>

  <th>

  </th>
</tr>
`wallet-type`

###Response - Create Wallet
  <th>
    Type
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *string*
  </td>

  <td>
    Wallet type.
  </td>
</tr>

<tr>
  <td>
    `wallet-token`
  </td>

  <td>
    *string*
  </td>

  <td>
    Token for the wallet.
  </td>
</tr>
Property Name
`wallet-type`

###Response - Update & Retrieve Apple Pay Onboarding Information
  <th>
    Type
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *string*
  </td>

  <td>
    Wallet type.
  </td>
</tr>

<tr>
  <td>
    `apple-pay`
  </td>

  <td>
    *container*
  </td>

  <td>
    Contains: 

    * `domain`  *string*  Name of the domain that will display the Apple Pay button.
  </td>
</tr>
Property Name
`wallet-type`

{`

`}

Visa Checkout

Request - Create Wallet

  <th>
    Type
  </th>

  <th>
    Required
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    Wallet type.\
    Value must be **VISA\_CHECKOUT**.
  </td>
</tr>

<tr>
  <td>
    `store-id`
  </td>

  <td>
    *long*
  </td>

  <td>
    **Required**\
    *Extended Payment API only*
  </td>

  <td>
    Merchant’s store ID.\
    Relevant only for the Extended Payment API.
  </td>
</tr>

<tr>
  <td>
    `call-id`
  </td>

  <td>
    *string*
  </td>

  <td>
    **Required**
  </td>

  <td>
    The ID returned from Visa Checkout on success event.\
    See [Implementing Visa Checkout](/docs/visa-checkout#section-implementing-visa-checkout).
  </td>
</tr>
Property Name
`wallet-type`

###Response - Create Wallet
  <th>
    Type
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *long*
  </td>

  <td>
    ID associated with this wallet resource.
  </td>
</tr>

<tr>
  <td>
    `first-name`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's first name.
  </td>
</tr>

<tr>
  <td>
    `last-name`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's last name.
  </td>
</tr>

<tr>
  <td>
    `email`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's email.
  </td>
</tr>

<tr>
  <td>
    `country`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's country code.\
    See [Country codes](/docs/country-codes).
  </td>
</tr>

<tr>
  <td>
    `phone`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's phone number.
  </td>
</tr>

<tr>
  <td>
    `credit-card`
  </td>

  <td>
    container
  </td>

  <td>
    Contains [credit-card](/v8976-XML/docs/credit-card) properties.
  </td>
</tr>

<tr>
  <td>
    `billing-contact-info`
  </td>

  <td>
    container
  </td>

  <td>
    Container of [billing-contact-info](/v8976-XML/docs/billing-contact-info) properties.
  </td>
</tr>

<tr>
  <td>
    `shipping-contact-info`
  </td>

  <td>
    container
  </td>

  <td>
    Container of [shipping-contact-info](/v8976-XML/docs/shipping-contact-info)  properties.
  </td>
</tr>
Property Name
`wallet-id`

###Response - Retrieve Wallet
  <th>
    Type
  </th>

  <th>
    Description
  </th>
</tr>
  <td>
    *string*
  </td>

  <td>
    Shopper's first name.
  </td>
</tr>

<tr>
  <td>
    `last-name`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's last name.
  </td>
</tr>

<tr>
  <td>
    `email`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's email.
  </td>
</tr>

<tr>
  <td>
    `country`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's country code.\
    See [Country codes](/docs/country-codes).
  </td>
</tr>

<tr>
  <td>
    `phone`
  </td>

  <td>
    *string*
  </td>

  <td>
    Shopper's phone number.
  </td>
</tr>

<tr>
  <td>
    `credit-card`
  </td>

  <td>
    container
  </td>

  <td>
    Container of [credit-card](/v8976-XML/docs/credit-card) properties.
  </td>
</tr>

<tr>
  <td>
    `billing-contact-info`
  </td>

  <td>
    container
  </td>

  <td>
    Container of [billing-contact-info](/v8976-XML/docs/billing-contact-info) properties.
  </td>
</tr>

<tr>
  <td>
    `shipping-contact-info`
  </td>

  <td>
    container
  </td>

  <td>
    Container of [shipping-contact-info](/v8976-XML/docs/shipping-contact-info)  properties.
  </td>
</tr>
Property Name
`first-name`

{`

`}