{"_id":"59a45d467ee621000fc9d434","category":{"_id":"59a45d447ee621000fc9d3c4","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T15:47:41.503Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":89,"body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`first-name`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Shopper's first name.\\nMaximum 100 characters.\",\n \"1-0\": \"`last-name`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"Shopper's last name.\\nMaximum 100 characters.\",\n \"h-4\": \"Description\",\n \"0-2\": \"**Required**\",\n \"1-2\": \"**Required**\",\n \"3-0\": \"`country`\",\n \"3-1\": \"*string*\",\n \"4-0\": \"`state`\",\n \"6-0\": \"`address`\",\n \"4-3\": \"Shopper's state code.\\nSee [State and province codes](/v1.0/docs/state-and-province-codes)\\nSupports US and Canada states only. For states in other countries, it is necessary to include the state within the `address` property.\",\n \"4-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"9-0\": \"`zip`\",\n \"9-1\": \"*string*\",\n \"10-0\": \"`phone`\",\n \"6-3\": \"Shopper's address line 1.\\nMaximum 100 characters.\",\n \"3-3\": \"Shopper's country code.\\nSee [Country codes](/v1.0/docs/country-codes)\",\n \"3-2\": \"Optional\",\n \"4-2\": \"Optional\",\n \"6-2\": \"Optional\",\n \"9-2\": \"Optional\",\n \"10-2\": \"Optional\",\n \"10-3\": \"Shopper's phone number.\\nBetween 2-36 characters.\\nAccepts numbers, letters, and these characters: ** + . * # / \\\\ ( ) - **\",\n \"9-3\": \"Shopper's ZIP code.\",\n \"10-1\": \"*string*\",\n \"8-0\": \"`email`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"Optional\",\n \"8-3\": \"Shopper's email address.\\nBetween 3-100 characters.\",\n \"12-0\": \"`shopper-currency`\",\n \"14-0\": \"`payment-sources`\",\n \"18-0\": \"`transaction-fraud-info`\",\n \"12-1\": \"*string*\",\n \"14-1\": \"container\",\n \"18-1\": \"container\",\n \"12-2\": \"Optional\",\n \"14-2\": \"Optional\",\n \"18-2\": \"Optional\",\n \"12-3\": \"Shopper's currency. See [Currency codes](/v1.0/docs/currency-codes).\",\n \"14-3\": \"Container of [payment-sources](doc:payment-sources) properties.\",\n \"18-3\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n \"15-0\": \"`shipping-contact-info`\",\n \"15-1\": \"container\",\n \"15-2\": \"Optional\",\n \"15-3\": \"Container of [shipping-contact-info](doc:shipping-contact-info) properties.\",\n \"17-3\": \"ID of the wallet, obtained via the [Create Wallet](/v4.0/docs/create-wallet) request.\\n\\n**Note**: Applicable for MasterPass and Visa Checkout.\",\n \"17-2\": \"Optional\",\n \"17-1\": \"container\",\n \"17-0\": \"`wallet-id`\",\n \"7-0\": \"`address2`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Optional\",\n \"7-3\": \"Shopper's address line 2.\\nBetween 2-42 characters.\",\n \"13-0\": \"`personal-identification-number`\",\n \"13-3\": \"The shopper's local personal identification number. These are the required ID types per country:\\n\\n * Argentina - DNI (length 7-11 chars)\\n * Brazil - CPF/CNPJ (length 11-14 chras)\\n * Chile - RUN (length 8-9 chars)\\n * Colombia - CC (length 6-10 chars)\\n * Mexico - CURP/RFC (length 10-18 chars)\",\n \"13-2\": \"**Required** for [local LatAm processing](v1.0/docs/latam-local-processing)\",\n \"13-1\": \"*string*\",\n \"5-0\": \"`city`\",\n \"5-1\": \"*string*\",\n \"5-2\": \"Optional\",\n \"5-3\": \"Shopper's city.\\nBetween 2-42 characters.\",\n \"2-0\": \"`merchant-shopper-id`\",\n \"2-1\": \"*string*\",\n \"2-2\": \"Optional\",\n \"2-3\": \"A merchant's ID for a specific shopper, up to 50 characters.\",\n \"11-0\": \"`company-name`\",\n \"11-1\": \"*string*\",\n \"11-2\": \"**Required** for Corporate ECP accounts.\",\n \"11-3\": \"Shopper's company name. \\n\\nMaximum 100 characters.\",\n \"16-0\": \"`soft-descriptor`\",\n \"16-1\": \"*string*\",\n \"16-2\": \"Optional; Relevant if sending a credit card number\",\n \"16-3\": \"Description that may appear on the shopper's bank statement when BlueSnap validates the card.\"\n },\n \"cols\": 4,\n \"rows\": 19\n}\n[/block]\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"1-0\": \"`first-name`\",\n \"1-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"1-3\": \"Cardholder's first name.\",\n \"2-0\": \"`last-name`\",\n \"2-1\": \"*string*\",\n \"2-3\": \"Cardholder's last name.\",\n \"h-4\": \"Description\",\n \"1-2\": \"Shopper's first name.\\nMaximum 100 characters.\",\n \"2-2\": \"Shopper's last name.\\nMaximum 100 characters.\",\n \"4-0\": \"`country`\",\n \"4-1\": \"*string*\",\n \"5-0\": \"`state`\",\n \"6-0\": \"`address`\",\n \"5-3\": \"Cardholder's state code.\\n\\nADD LINK TO LIST OF STATE CODES\",\n \"5-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"9-0\": \"`zip`\",\n \"9-1\": \"*string*\",\n \"10-0\": \"`phone`\",\n \"6-3\": \"Cardholder's address.\",\n \"4-3\": \"Cardholder's country code.\\n\\nADD LINK TO LIST OF COUNTRY CODES\",\n \"4-2\": \"Shopper's country code.\\nSee [Country codes](/v1.0/docs/country-codes)\",\n \"5-2\": \"Shopper's state code.\\nSee [State and province codes](/v1.0/docs/state-and-province-codes)\",\n \"6-2\": \"Shopper's address line 1.\\nMaximum 100 characters.\",\n \"9-2\": \"Shopper's ZIP code.\",\n \"10-2\": \"Shopper's phone number.\\nBetween 2-36 characters.\",\n \"10-3\": \"Cardholder's phone number.\",\n \"9-3\": \"Cardholder's ZIP code.\",\n \"10-1\": \"*string*\",\n \"8-0\": \"`email`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"Shopper's email address.\\nBetween 3-100 characters.\",\n \"12-2\": \"Shopper's currency. See [Currency codes](/v1.0/docs/currency-codes).\",\n \"14-2\": \"Container of [payment-sources](doc:payment-sources) properties.\",\n \"17-2\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n \"17-1\": \"container\",\n \"14-1\": \"container\",\n \"12-1\": \"*string*\",\n \"12-0\": \"`shopper-currency`\",\n \"14-0\": \"`payment-sources`\",\n \"17-0\": \"`transaction-fraud-info`\",\n \"16-2\": \"Container of [shipping-contact-info](doc:shipping-contact-info) properties.\",\n \"16-1\": \"container\",\n \"16-0\": \"`shipping-contact-info`\",\n \"18-2\": \"Container of [fraud-result-info](doc:fraud-result-info) properties.\",\n \"18-1\": \"container\",\n \"18-0\": \"`fraud-result-info`\",\n \"15-2\": \"Container of [last-payment-info](doc:last-payment-info) properties.\",\n \"15-1\": \"container\",\n \"15-0\": \"`last-payment-info`\",\n \"7-0\": \"`address2`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Shopper's address line 2.\\nBetween 2-42 characters.\",\n \"0-1\": \"*integer*\",\n \"0-0\": \"`vaulted-shopper-id`\",\n \"0-2\": \"ID of an existing vaulted shopper.\",\n \"13-0\": \"`personal-identification-number`\",\n \"13-1\": \"*string*\",\n \"13-2\": \"The shopper's local personal identification number. These are the required ID types per country:\\n\\n * Argentina - DNI (length 7-11 chars)\\n * Brazil - CPF/CNPJ (length 11-14 chras)\\n * Chile - RUN (length 8-9 chars)\\n * Colombia - CC (length 6-10 chars)\\n * Mexico - CURP/RFC (length 10-18 chars)\",\n \"3-2\": \"A merchant's ID for a specific shopper, up to 50 characters.\",\n \"3-1\": \"*string*\",\n \"3-0\": \"`merchant-shopper-id`\",\n \"11-0\": \"`company-name`\",\n \"11-1\": \"*string*\",\n \"11-2\": \"Shopper's company name\"\n },\n \"cols\": 3,\n \"rows\": 19\n}\n[/block]","excerpt":"Contains information about the vaulted shopper","slug":"vaulted-shopper","type":"basic","title":"vaulted-shopper"}vaulted-shopper
Contains information about the vaulted shopper
Property Name
Type
Required
Description
first-name
string
Required
Shopper's first name.
Maximum 100 characters.
last-name
string
Required
Shopper's last name.
Maximum 100 characters.
merchant-shopper-id
string
Optional
A merchant's ID for a specific shopper, up to 50 characters.
state
string
Optional
Shopper's state code.
See State and province codes
Supports US and Canada states only. For states in other countries, it is necessary to include the state within the address property.
city
string
Optional
Shopper's city.
Between 2-42 characters.
address
string
Optional
Shopper's address line 1.
Maximum 100 characters.
address2
string
Optional
Shopper's address line 2.
Between 2-42 characters.
email
string
Optional
Shopper's email address.
Between 3-100 characters.
zip
string
Optional
Shopper's ZIP code.
phone
string
Optional
Shopper's phone number.
Between 2-36 characters.
Accepts numbers, letters, and these characters: + . * # / \ ( ) -
company-name
string
Required for Corporate ECP accounts.
Shopper's company name.
Maximum 100 characters.
personal-identification-number
string
Required for local LatAm processing
The shopper's local personal identification number. These are the required ID types per country:
- Argentina - DNI (length 7-11 chars)
- Brazil - CPF/CNPJ (length 11-14 chras)
- Chile - RUN (length 8-9 chars)
- Colombia - CC (length 6-10 chars)
- Mexico - CURP/RFC (length 10-18 chars)
soft-descriptor
string
Optional; Relevant if sending a credit card number
Description that may appear on the shopper's bank statement when BlueSnap validates the card.
wallet-id
container
Optional
ID of the wallet, obtained via the Create Wallet request.
Note: Applicable for MasterPass and Visa Checkout.
Property Name
Type
Description
vaulted-shopper-id
integer
ID of an existing vaulted shopper.
first-name
string
Shopper's first name.
Maximum 100 characters.
last-name
string
Shopper's last name.
Maximum 100 characters.
merchant-shopper-id
string
A merchant's ID for a specific shopper, up to 50 characters.
address
string
Shopper's address line 1.
Maximum 100 characters.
address2
string
Shopper's address line 2.
Between 2-42 characters.
email
string
Shopper's email address.
Between 3-100 characters.
zip
string
Shopper's ZIP code.
phone
string
Shopper's phone number.
Between 2-36 characters.
company-name
string
Shopper's company name
personal-identification-number
string
The shopper's local personal identification number. These are the required ID types per country:
- Argentina - DNI (length 7-11 chars)
- Brazil - CPF/CNPJ (length 11-14 chras)
- Chile - RUN (length 8-9 chars)
- Colombia - CC (length 6-10 chars)
- Mexico - CURP/RFC (length 10-18 chars)