{"_id":"5bdc633c15437b0042ed9620","category":{"_id":"5bdc633c15437b0042ed95f9","version":"5bdc633c15437b0042ed963c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T12:18:27.941Z","from_sync":false,"order":12,"slug":"wallets","title":"Wallets"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bdc633c15437b0042ed963c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bc48b4f9919d4000df5ea7b","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z","categories":["5bdc633c15437b0042ed95f4","5bdc633c15437b0042ed95f5","5bdc633c15437b0042ed95f6","5bdc633c15437b0042ed95f7","5bdc633c15437b0042ed95f8","5bdc633c15437b0042ed95f9","5bdc633c15437b0042ed95fa","5bdc633c15437b0042ed95fb","5bdc633c15437b0042ed95fc","5bdc633c15437b0042ed95fd","5bdc633c15437b0042ed95fe","5bdc633c15437b0042ed95ff","5b34c737e0dca2000311de6a","5bdc633c15437b0042ed9600"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28.0 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-22T18:48:17.978Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":7,"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###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 - 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]","excerpt":"Contains information needed to launch a wallet payment page and returns the shopper details from the wallet.","slug":"wallet","type":"basic","title":"wallet (XML resource)"}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, Masterpass, or Visa Checkout:
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.
display-name
string
Optional
The name displayed on Touch Bar of newer Macs.
Maximum 64 characters.
Property Name
Type
Required
Description
wallet-type
string
Required
Wallet type.
Value must be APPLE_PAY.
apple-pay
container
Required
Contains:
domainstring Required Name of the domain that will display the Apple Pay button.
Notes:
- Request may have more than one
domainproperty. - Do not include
https://
Property Name
Type
Description
wallet-type
string
Wallet type.
wallet-token
string
Token for the wallet.
Property Name
Type
Description
wallet-type
string
Wallet type.
apple-pay
container
Contains:
domainstring Name of the domain that will display the Apple Pay button.
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.
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
Property Name
Type
Description
first-name
string
Shopper's first name.
last-name
string
Shopper's last name.
email
string
Shopper's email.
phone
string
Shopper's phone number.
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.
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.
phone
string
Shopper's phone number.
Property Name
Type
Description
first-name
string
Shopper's first name.
last-name
string
Shopper's last name.
email
string
Shopper's email.
phone
string
Shopper's phone number.