{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"vaulted-shopper","type":"basic","slug":"vaulted-shopper","excerpt":"Contains information about the vaulted shopper","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.\\nFor ACH/ECP, the limit is 25 characters.\",\n \"1-0\": \"`last-name`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"Shopper's last name.\\nMaximum 100 characters.\\nFor ACH/ECP, the limit is 25 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](/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](/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. Maximum 20 characters.\",\n \"10-1\": \"*string*\",\n \"12-0\": \"`shopper-currency`\",\n \"14-0\": \"`payment-sources`\",\n \"19-0\": \"`transaction-fraud-info`\",\n \"12-1\": \"*string*\",\n \"14-1\": \"container\",\n \"19-1\": \"container\",\n \"12-2\": \"Optional\",\n \"14-2\": \"Optional\",\n \"19-2\": \"Optional\",\n \"12-3\": \"Shopper's currency. See [Currency codes](/docs/currency-codes).\",\n \"14-3\": \"Container of [payment-sources](doc:payment-sources) properties.\",\n \"19-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 \"18-3\": \"ID of the wallet, obtained via the [Create Wallet](/v8976-Tools/docs/create-wallet) request.\\n\\n**Note**: Applicable for MasterPass and Visa Checkout.\",\n \"18-2\": \"Optional\",\n \"18-1\": \"container\",\n \"18-0\": \"`wallet-id`\",\n \"7-0\": \"`address2`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Optional\",\n \"7-3\": \"Shopper's address line 2.\\nMaximum 100 characters.\",\n \"13-0\": \"`personal-identification-number`\",\n \"13-3\": \"The shopper's local personal identification number. These are the 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 * Mexico - CURP/RFC (length 10-18 chars)\",\n \"13-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) in Brazil\",\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. Maximum 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. Maximum 20 characters.\",\n \"17-0\": \"`descriptor-phone-number`\",\n \"17-1\": \"*string*\",\n \"17-2\": \"Optional; Relevant if sending a credit card number\",\n \"17-3\": \"Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card. Maximum 20 characters.\",\n \"8-0\": \"`email`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"Optional\",\n \"8-3\": \"Shopper's email address.\",\n \"20-0\": \"`transaction-order-source`\",\n \"20-1\": \"*string*\",\n \"20-2\": \"Optional\",\n \"20-3\": \"Identifies the order type.<br />The only option is `MOTO` (**M**ail **O**rder **T**elephone **O**rder). <br />Any other option is ignored.\",\n \"21-0\": \"`three-d-secure`\",\n \"21-1\": \"container\",\n \"21-2\": \"Optional\",\n \"21-3\": \"Container of [three-d-secure](https://developers.bluesnap.com/v8976-XML/docs/three-d-secure) properties.\",\n \"22-0\": \"`chosen-payment-method`\",\n \"22-1\": \"container\",\n \"22-2\": \"Optional; Only relevant for Update Vaulted Shopper requests\",\n \"22-3\": \"Container of [chosen-payment-method](doc:chosen-payment-method) properties.\"\n },\n \"cols\": 4,\n \"rows\": 23\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](/docs/country-codes)\",\n \"5-2\": \"Shopper's state code.\\nSee [State and province codes](/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 \"12-2\": \"Shopper's currency. See [Currency codes](/docs/currency-codes).\",\n \"16-2\": \"Container of [payment-sources](doc:payment-sources) properties.\",\n \"16-1\": \"container\",\n \"12-1\": \"*string*\",\n \"12-0\": \"`shopper-currency`\",\n \"16-0\": \"`payment-sources`\",\n \"18-2\": \"Container of [shipping-contact-info](doc:shipping-contact-info) properties.\",\n \"18-1\": \"container\",\n \"18-0\": \"`shipping-contact-info`\",\n \"19-2\": \"Container of [fraud-result-info](doc:fraud-result-info) properties.\",\n \"19-1\": \"container\",\n \"19-0\": \"`fraud-result-info`\",\n \"17-2\": \"Container of [last-payment-info](doc:last-payment-info) properties.\",\n \"17-1\": \"container\",\n \"17-0\": \"`last-payment-info`\",\n \"7-0\": \"`address2`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Shopper's address line 2.\\nMaximum 100 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 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 * 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 \"15-0\": \"`descriptor-phone-number`\",\n \"15-1\": \"*string*\",\n \"15-2\": \"Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card.\",\n \"14-0\": \"`soft-descriptor`\",\n \"14-1\": \"*string*\",\n \"14-2\": \"Description that may appear on the shopper's bank statement when BlueSnap validates the card.\",\n \"8-0\": \"`email`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"Shopper's email address.\",\n \"20-0\": \"`three-d-secure`\",\n \"20-1\": \"container\",\n \"20-2\": \"Container of [three-d-secure](https://developers.bluesnap.com/v8976-XML/docs/three-d-secure) properties.\",\n \"21-0\": \"`chosen-payment-method`\",\n \"21-1\": \"container\",\n \"21-2\": \"Container of [chosen-payment-method](doc:chosen-payment-method) properties.\",\n \"22-0\": \"`date-created`\",\n \"22-1\": \"*string*\",\n \"22-2\": \"The date the vaulted shopper was created.\",\n \"23-0\": \"`time-created`\",\n \"23-1\": \"*string*\",\n \"23-2\": \"The time (PST) the vaulted shopper was created.\"\n },\n \"cols\": 3,\n \"rows\": 24\n}\n[/block]","updates":[],"order":56,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603d5be8af8f1a0061138199","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603d5be8af8f1a00611380fb","603d5be8af8f1a00611380fc","603d5be8af8f1a00611380fd","603d5be8af8f1a00611380fe","603d5be8af8f1a00611380ff","603d5be8af8f1a0061138100","603d5be8af8f1a0061138101","603d5be8af8f1a0061138102","603d5be8af8f1a0061138103","603d5be8af8f1a0061138104","603d5be8af8f1a0061138105","603d5be8af8f1a0061138106","603d5be8af8f1a0061138107","603d5be8af8f1a0061138108","603d5be8af8f1a0061138109","603d5be8af8f1a006113810a","603d5be8af8f1a006113810b","603d5be8af8f1a006113810c","603d5be8af8f1a006113810d","603d5be8af8f1a006113810e"],"_id":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5ff4b747849e1b03c50684c7","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"603d5be8af8f1a0061138107","version":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-07-18T14:15:48.879Z","__v":0,"parentDoc":null}vaulted-shopper
first-name
string
Required
Shopper's first name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.
last-name
string
Required
Shopper's last name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 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.
Maximum 100 characters.
email
string
Optional
Shopper's email address.
zip
string
Optional
Shopper's ZIP code. Maximum 20 characters.
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 in Brazil
The shopper's local personal identification number. These are the ID types per country:
- Argentina - DNI (length 7-11 chars)
- Brazil - CPF/CNPJ (length 11-14 chras)
- Chile - RUN (length 8-9 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. Maximum 20 characters.
descriptor-phone-number
string
Optional; Relevant if sending a credit card number
Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card. Maximum 20 characters.
wallet-id
container
Optional
ID of the wallet, obtained via the Create Wallet request.
Note: Applicable for MasterPass and Visa Checkout.
transaction-order-source
string
Optional
Identifies the order type.
The only option is MOTO (Mail Order Telephone Order).
Any other option is ignored.
chosen-payment-method
container
Optional; Only relevant for Update Vaulted Shopper requests
Container of chosen-payment-method properties.
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.
Maximum 100 characters.
email
string
Shopper's email address.
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 ID types per country:
- Argentina - DNI (length 7-11 chars)
- Brazil - CPF/CNPJ (length 11-14 chras)
- Chile - RUN (length 8-9 chars)
- Mexico - CURP/RFC (length 10-18 chars)
soft-descriptor
string
Description that may appear on the shopper's bank statement when BlueSnap validates the card.
descriptor-phone-number
string
Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card.
date-created
string
The date the vaulted shopper was created.
time-created
string
The time (PST) the vaulted shopper was created.
