wallet (XML resource)

{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"wallet (XML resource)","type":"basic","slug":"wallet","excerpt":"Contains information needed to launch a wallet payment page and returns the shopper details from the wallet.","body":"Includes the following properties, depending on whether it is for Apple Pay on the web, Masterpass, or Visa Checkout:\n<br />\n[block:html]\n{\n \"html\": \"<ul class=\\\"nav nav-tabs\\\">\\n <li class=\\\"active\\\"><a data-toggle=\\\"tab\\\" href=\\\"#Apple-Pay\\\">Apple Pay</a></li>\\n <li><a data-toggle=\\\"tab\\\" href=\\\"#Masterpass\\\">Masterpass</a></li>\\n <li><a data-toggle=\\\"tab\\\" href=\\\"#Visa-Checkout\\\">Visa Checkout</a></li>\\n</ul>\\n<div class=\\\"tab-content\\\">\\n <div id=\\\"Apple-Pay\\\" class=\\\"tab-pane fade in active\\\">\"\n}\n[/block]\n##Apple Pay\n###Request - Create Wallet\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"h-3\": \"Description\",\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"Wallet Type. \\nValue must be **APPLE_PAY**.\",\n \"1-0\": \"`validation-url`\",\n \"1-1\": \"*string*\",\n \"1-2\": \"**Required**\",\n \"1-3\": \"The URL used to validate the merchant's server.\\n\\nValue is extracted from Apple Pay JS. See [Apple Pay Guide](/docs/apple-pay#section-step-4-set-up-the-onvalidatemerchant-callback).\",\n \"2-0\": \"`domain-name`\",\n \"2-1\": \"*string*\",\n \"2-2\": \"**Required**\",\n \"2-3\": \"Merchant's [registered domain](/docs/apple-pay#section-step-1-verify-your-domain).\",\n \"3-0\": \"`display-name`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"The name displayed on Touch Bar of newer Macs. \\n\\nMaximum 64 characters.\"\n },\n \"cols\": 4,\n \"rows\": 4\n}\n[/block]\n<hr>\n###Request - Onboard Apple Pay\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"h-3\": \"Description\",\n \"0-1\": \"*string*\",\n \"0-0\": \"`wallet-type`\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"Wallet type.\\nValue must be **APPLE_PAY**.\",\n \"1-0\": \"`apple-pay`\",\n \"1-1\": \"*container*\",\n \"1-2\": \"**Required**\",\n \"1-3\": \"Contains: \\n* `domain`  *string*  **Required**  Name of the domain that will display the Apple Pay button. \\n\\n**Notes**: \\n* Request may have more than one `domain` property.\\n* Do not include `https://`\"\n },\n \"cols\": 4,\n \"rows\": 2\n}\n[/block]\n<hr>\n### Request - Update Apple Pay Onboarding Information\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"Wallet type.\\nValue must be **APPLE_PAY**.\",\n \"1-0\": \"`apple-pay`\",\n \"1-1\": \"*container*\",\n \"1-2\": \"**Required**\",\n \"1-3\": \"Contains: \\n* `domain`  *string*  Optional  Name of the domain to register. \\n\\n* `unregister-domain`  *string*  Optional  Name of the domain to unregister\\n\\n**Note:** Do not include `https://` in the domain name\"\n },\n \"cols\": 4,\n \"rows\": 2\n}\n[/block]\n<hr>\n###Response - Create Wallet\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"Wallet type.\",\n \"1-0\": \"`wallet-token`\",\n \"1-1\": \"*string*\",\n \"1-2\": \"Token for the wallet.\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]\n<hr>\n###Response - Update & Retrieve Apple Pay Onboarding Information \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"Wallet type.\",\n \"1-0\": \"`apple-pay`\",\n \"1-1\": \"*container*\",\n \"1-2\": \"Contains: \\n* `domain`  *string*  Name of the domain that will display the Apple Pay button.\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]\n\n[block:html]\n{\n \"html\": \" </div>\\n <div id=\\\"Masterpass\\\" class=\\\"tab-pane fade\\\">\"\n}\n[/block]\n##Masterpass\n###Request - Create Wallet \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Wallet type.\\nValue must be **MASTERPASS**.\",\n \"2-0\": \"`origin-url`\",\n \"2-1\": \"*string*\",\n \"2-3\": \"URL of the page from which the JS function to launch the wallet lightbox was called.\",\n \"h-4\": \"Description\",\n \"0-2\": \"**Required**\",\n \"2-2\": \"**Required**\",\n \"3-0\": \"`return-url`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"**Required**\",\n \"3-3\": \"URL of a page (e.g. a servlet) that the browser will be redirected to after submitting the Masterpass lightbox. Request will contain the `operation` and `wallet-id` parameters. For more info, see [Implementing Masterpass](/docs/masterpass#section-implementing-masterpass-via-the-api).\",\n \"1-0\": \"`store-id`\",\n \"1-1\": \"*long*\",\n \"1-2\": \"**Required** \\n*Extended Payment API only*\",\n \"1-3\": \"Merchant’s store ID.\\nRelevant only for the Extended Payment API.\"\n },\n \"cols\": 4,\n \"rows\": 4\n}\n[/block]\n<hr>\n###Response - Create Wallet \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"1-0\": \"`wallet-token`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"BlueSnap identifier for the transaction.\",\n \"h-4\": \"Description\",\n \"0-2\": \"Wallet type.\",\n \"1-2\": \"Token for the wallet.\",\n \"2-0\": \"`merchant-checkout-id`\",\n \"2-1\": \"*string*\",\n \"2-2\": \"Merchant checkout ID for the session.\",\n \"3-0\": \"`allowed-card-types`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Comma-separated list of the supported card types.\\nFor example: **master,amex,diners,discover,visa**\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\n<hr>\n###Response - Retrieve Wallet \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`first-name`\",\n \"1-0\": \"`last-name`\",\n \"2-0\": \"`email`\",\n \"3-0\": \"`country`\",\n \"4-0\": \"`phone`\",\n \"5-2\": \"Container of [credit-card](/v8976-XML/docs/credit-card) properties.\",\n \"5-0\": \"`credit-card`\",\n \"5-1\": \"container\",\n \"0-1\": \"*string*\",\n \"1-1\": \"*string*\",\n \"2-1\": \"*string*\",\n \"3-1\": \"*string*\",\n \"4-1\": \"*string*\",\n \"0-2\": \"Shopper's first name.\",\n \"1-2\": \"Shopper's last name.\",\n \"2-2\": \"Shopper's email.\",\n \"3-2\": \"Shopper's country code.\\nSee [Country codes](/docs/country-codes).\",\n \"4-2\": \"Shopper's phone number.\",\n \"6-0\": \"`billing-contact-info`\",\n \"6-2\": \"Container of [billing-contact-info](/v8976-XML/docs/billing-contact-info) properties.\",\n \"6-1\": \"container\",\n \"7-0\": \"`shipping-contact-info`\",\n \"7-1\": \"container\",\n \"7-2\": \"Container of [shipping-contact-info](/v8976-XML/docs/shipping-contact-info) properties.\"\n },\n \"cols\": 3,\n \"rows\": 8\n}\n[/block]\n\n[block:html]\n{\n \"html\": \" </div>\\n <div id=\\\"Visa-Checkout\\\" class=\\\"tab-pane fade\\\">\"\n}\n[/block]\n##Visa Checkout\n###Request - Create Wallet \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"h-3\": \"Description\",\n \"0-0\": \"`wallet-type`\",\n \"0-1\": \"*string*\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"Wallet type.\\nValue must be **VISA_CHECKOUT**.\",\n \"1-0\": \"`store-id`\",\n \"1-1\": \"*long*\",\n \"1-2\": \"**Required** \\n*Extended Payment API only*\",\n \"1-3\": \"Merchant’s store ID.\\nRelevant only for the Extended Payment API.\",\n \"2-0\": \"`call-id`\",\n \"2-1\": \"*string*\",\n \"2-2\": \"**Required**\",\n \"2-3\": \"The ID returned from Visa Checkout on success event.\\nSee [Implementing Visa Checkout](/docs/visa-checkout#section-implementing-visa-checkout).\"\n },\n \"cols\": 4,\n \"rows\": 3\n}\n[/block]\n<hr>\n###Response - Create Wallet\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`wallet-id`\",\n \"8-2\": \"Container of [shipping-contact-info](/v8976-XML/docs/shipping-contact-info) properties.\",\n \"8-0\": \"`shipping-contact-info`\",\n \"8-1\": \"container\",\n \"7-1\": \"container\",\n \"6-1\": \"container\",\n \"7-0\": \"`billing-contact-info`\",\n \"7-2\": \"Container of [billing-contact-info](/v8976-XML/docs/billing-contact-info) properties.\",\n \"6-0\": \"`credit-card`\",\n \"6-2\": \"Contains [credit-card](/v8976-XML/docs/credit-card) properties.\",\n \"5-0\": \"`phone`\",\n \"4-0\": \"`country`\",\n \"3-0\": \"`email`\",\n \"1-0\": \"`first-name`\",\n \"2-0\": \"`last-name`\",\n \"0-1\": \"*long*\",\n \"1-1\": \"*string*\",\n \"2-1\": \"*string*\",\n \"3-1\": \"*string*\",\n \"4-1\": \"*string*\",\n \"5-1\": \"*string*\",\n \"5-2\": \"Shopper's phone number.\",\n \"4-2\": \"Shopper's country code.\\nSee [Country codes](/docs/country-codes).\",\n \"3-2\": \"Shopper's email.\",\n \"2-2\": \"Shopper's last name.\",\n \"1-2\": \"Shopper's first name.\",\n \"0-2\": \"ID associated with this wallet resource.\"\n },\n \"cols\": 3,\n \"rows\": 9\n}\n[/block]\n<hr>\n###Response - Retrieve Wallet \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`first-name`\",\n \"1-0\": \"`last-name`\",\n \"2-0\": \"`email`\",\n \"3-0\": \"`country`\",\n \"4-0\": \"`phone`\",\n \"5-2\": \"Container of [credit-card](/v8976-XML/docs/credit-card) properties.\",\n \"5-0\": \"`credit-card`\",\n \"5-1\": \"container\",\n \"0-1\": \"*string*\",\n \"1-1\": \"*string*\",\n \"2-1\": \"*string*\",\n \"3-1\": \"*string*\",\n \"4-1\": \"*string*\",\n \"0-2\": \"Shopper's first name.\",\n \"1-2\": \"Shopper's last name.\",\n \"2-2\": \"Shopper's email.\",\n \"3-2\": \"Shopper's country code.\\nSee [Country codes](/docs/country-codes).\",\n \"4-2\": \"Shopper's phone number.\",\n \"6-0\": \"`billing-contact-info`\",\n \"6-2\": \"Container of [billing-contact-info](/v8976-XML/docs/billing-contact-info) properties.\",\n \"6-1\": \"container\",\n \"7-0\": \"`shipping-contact-info`\",\n \"7-1\": \"container\",\n \"7-2\": \"Container of [shipping-contact-info](/v8976-XML/docs/shipping-contact-info) properties.\"\n },\n \"cols\": 3,\n \"rows\": 8\n}\n[/block]\n\n[block:html]\n{\n \"html\": \"</div>\\n</div>\"\n}\n[/block]","updates":[],"order":8,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603fec227146110018e1da6d","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wallets","slug":"wallets","order":18,"from_sync":false,"reference":true,"_id":"603fec227146110018e1da42","version":"603fec227146110018e1daaf","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-05-17T12:18:27.941Z","__v":0},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603fec227146110018e1da3d","603fec227146110018e1da3e","603fec227146110018e1da3f","603fec227146110018e1da40","603fec227146110018e1da41","603fec227146110018e1da42","603fec227146110018e1da43","603fec227146110018e1da44","603fec227146110018e1da45","603fec227146110018e1da46","603fec227146110018e1da47","603fec227146110018e1da48","5b34c737e0dca2000311de6a","603fec227146110018e1da49","603fec227146110018e1da4a","603fec227146110018e1da4b","603fec227146110018e1da4c","603fec227146110018e1da4d","603fec227146110018e1da4e","603fec227146110018e1da4f"],"_id":"603fec227146110018e1daaf","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6019bc72944282005e966fd4","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"createdAt":"2016-06-22T18:48:17.978Z","githubsync":"","__v":0}

Includes the following properties, depending on whether it is for Apple Pay on the web, Masterpass, 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.

Masterpass

Request - Create Wallet

Property Name

Type

Required

Description

wallet-type

string

Required

Wallet type.
Value must be MASTERPASS.

store-id

long

Required
Extended Payment API only

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

origin-url

string

Required

URL of the page from which the JS function to launch the wallet lightbox was called.

return-url

string

Required

URL of a page (e.g. a servlet) that the browser will be redirected to after submitting the Masterpass lightbox. Request will contain the operation and wallet-id parameters. For more info, see Implementing Masterpass.

Response - Create Wallet

Property Name

Type

Description

wallet-type

string

Wallet type.

wallet-token

string

Token for the wallet.

merchant-checkout-id

string

Merchant checkout ID for the session.

allowed-card-types

string

Comma-separated list of the supported card types.
For example: master,amex,diners,discover,visa

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.

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.

Developer Hub

BlueSnap Reporting & Tools

Reporting API

Custom Reporting API

3D Secure

Account Updater

Bank Directory

Convert Currency

Embedded Checkout

Encrypt/Decrypt Parameters

Hosted Payment Fields

Logos & Images

Payment Request Button

Retrieve Card Info

Retrieve Payment Methods

Secured Payment Collector

SEPA Direct Debit

Tax Quotes

User Management

Wallets

Apple Pay

Request - Create Wallet

Request - Onboard Apple Pay

Request - Update Apple Pay Onboarding Information

Response - Create Wallet

Response - Update & Retrieve Apple Pay Onboarding Information

Masterpass

Request - Create Wallet

Response - Create Wallet

Response - Retrieve Wallet

Visa Checkout

Request - Create Wallet

Response - Create Wallet

Response - Retrieve Wallet