{"_id":"5a7859c639d48800123298d7","category":{"_id":"5a7859c639d48800123298c5","version":"5a7859c639d48800123298c0","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T12:18:27.941Z","from_sync":false,"order":5,"slug":"wallets","title":"Wallets"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5a7859c639d48800123298c0","project":"57336fd5a6a9c40e00e13a0b","__v":2,"createdAt":"2018-02-05T13:19:02.408Z","releaseDate":"2018-02-05T13:19:02.408Z","categories":["5a7859c639d48800123298c1","5a7859c639d48800123298c2","5a7859c639d48800123298c3","5a7859c639d48800123298c4","5a7859c639d48800123298c5","5a7859c639d48800123298c6","5a7859c639d48800123298c7","5a7859c639d48800123298c8","5a7859c639d48800123298c9","5a7859c639d48800123298ca","5a785b7f39d488001232996a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.1 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-20T12:16:51.168Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":6,"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\": \"`walletType`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Wallet type.\\nValue must be **APPLE_PAY**.\",\n    \"1-0\": \"`validationUrl`\",\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 `event.validationURL`. See [Apple Pay Guide](/v1.0/docs/apple-pay#section-step-4-set-up-the-onvalidatemerchant-callback).\",\n    \"2-0\": \"`domainName`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"**Required**\",\n    \"2-3\": \"Merchant's [registered domain](/v1.0/docs/apple-pay#section-step-1-verify-your-domain).\",\n    \"3-0\": \"`displayName`\",\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-0\": \"`walletType`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Wallet type.\\nValue must be **APPLE_PAY**.\",\n    \"1-0\": \"`applePay`\",\n    \"1-1\": \"*object*\",\n    \"1-2\": \"**Required**\",\n    \"1-3\": \"Object containing: \\n* `domains` &nbsp;&nbsp;*array*&nbsp;&nbsp;**Required** &nbsp;&nbsp; Contains the domain names that will display the Apple Pay button (e.g. [\\\"merchant.com\\\", \\\"bluesnap.com\\\"]).\\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\": \"`walletType`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Wallet type.\",\n    \"1-0\": \"`walletToken`\",\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\": \"`walletType`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Wallet type.\",\n    \"1-0\": \"`applePay`\",\n    \"1-1\": \"*object*\",\n    \"1-2\": \"Object containing: \\n* `domains` &nbsp;&nbsp;*array*&nbsp;&nbsp;Contains the domain names that will display the Apple Pay button (e.g. [\\\"merchant.com\\\", \\\"bluesnap.com\\\"]).\"\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\": \"`walletType`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Wallet type.\\nValue must be **MASTERPASS**.\",\n    \"1-0\": \"`originUrl`\",\n    \"1-1\": \"*string*\",\n    \"1-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    \"1-2\": \"**Required**\",\n    \"2-0\": \"`returnUrl`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"**Required**\",\n    \"2-3\": \"URL of a page (e.g. a servlet) that will listen to GET requests from BlueSnap with the `operation` and `walletId` parameters. For more info, see [Implementing MasterPass](/v1.0/docs/masterpass#section-implementing-masterpass-via-the-api).\"\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\": \"`walletType`\",\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\": \"`walletToken`\",\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\": \"`merchantCheckoutId`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Merchant checkout ID for the session.\",\n    \"3-0\": \"`allowedCardTypes`\",\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\": \"`firstName`\",\n    \"1-0\": \"`lastName`\",\n    \"2-0\": \"`email`\",\n    \"3-0\": \"`country`\",\n    \"4-0\": \"`phone`\",\n    \"5-2\": \"Container of [creditCard](/v2.1/docs/credit-card) properties.\",\n    \"5-0\": \"`creditCard`\",\n    \"5-1\": \"*object*\",\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](/v1.0/docs/country-codes).\",\n    \"4-2\": \"Shopper's phone number.\",\n    \"6-0\": \"`billingContactInfo`\",\n    \"6-2\": \"Container of [billingContactInfo](/v2.1/docs/billing-contact-info) properties.\",\n    \"6-1\": \"*object*\",\n    \"7-0\": \"`shippingContactInfo`\",\n    \"7-1\": \"*object*\",\n    \"7-2\": \"Container of [shippingContactInfo](/v2.1/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\": \"`walletType`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Wallet type.\\nValue must be **VISA_CHECKOUT**.\",\n    \"1-0\": \"`callId`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"**Required**\",\n    \"1-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\": 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\": \"`walletId`\",\n    \"8-2\": \"Container of [shippingContactInfo](/v2.1/docs/shipping-contact-info)  properties.\",\n    \"8-0\": \"`shippingContactInfo`\",\n    \"8-1\": \"*object*\",\n    \"7-1\": \"*object*\",\n    \"6-1\": \"*object*\",\n    \"7-0\": \"`billingContactInfo`\",\n    \"7-2\": \"Container of [billingContactInfo](/v2.1/docs/billing-contact-info) properties.\",\n    \"6-0\": \"`creditCard`\",\n    \"6-2\": \"Contains [creditCard](/v2.1/docs/credit-card) properties.\",\n    \"5-0\": \"`phone`\",\n    \"4-0\": \"`country`\",\n    \"3-0\": \"`email`\",\n    \"1-0\": \"`firstName`\",\n    \"2-0\": \"`lastName`\",\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](/v1.0/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\": \"`firstName`\",\n    \"1-0\": \"`lastName`\",\n    \"2-0\": \"`email`\",\n    \"3-0\": \"`country`\",\n    \"4-0\": \"`phone`\",\n    \"5-2\": \"Container of [creditCard](/v2.1/docs/credit-card) properties.\",\n    \"5-0\": \"`creditCard`\",\n    \"5-1\": \"*object*\",\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](/v1.0/docs/country-codes).\",\n    \"4-2\": \"Shopper's phone number.\",\n    \"6-0\": \"`billingContactInfo`\",\n    \"6-2\": \"Container of [billingContactInfo](/v2.1/docs/billing-contact-info) properties.\",\n    \"6-1\": \"*object*\",\n    \"7-0\": \"`shippingContactInfo`\",\n    \"7-1\": \"*object*\",\n    \"7-2\": \"Container of [shippingContactInfo](/v2.1/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-json","type":"basic","title":"wallet (JSON object)"}

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 whether it is for Apple Pay on the web, MasterPass, 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


Response - Create Wallet

Property Name
Type
Description

walletType

string

Wallet type.

walletToken

string

Token for the wallet.


Response - 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"]).

MasterPass

Request - Create Wallet

Property Name
Type
Required
Description

walletType

string

Required

Wallet type.
Value must be MASTERPASS.

originUrl

string

Required

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

returnUrl

string

Required

URL of a page (e.g. a servlet) that will listen to GET requests from BlueSnap with the operation and walletId parameters. For more info, see Implementing MasterPass.


Response - Create Wallet

Property Name
Type
Description

walletType

string

Wallet type.

walletToken

string

Token for the wallet.

merchantCheckoutId

string

Merchant checkout ID for the session.

allowedCardTypes

string

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


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.

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.