vaultedShopper

{"_id":"5ab0f574ade4f4003cf6afaa","category":{"_id":"5ab0f55fade4f4003cf6af44","version":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-03-20T11:49:45.000Z","releaseDate":"2018-03-20T11:49:45.000Z","categories":["5ab0f55fade4f4003cf6af39","5ab0f55fade4f4003cf6af3a","5ab0f55fade4f4003cf6af3b","5ab0f55fade4f4003cf6af3c","5ab0f55fade4f4003cf6af3d","5ab0f55fade4f4003cf6af3e","5ab0f55fade4f4003cf6af3f","5ab0f55fade4f4003cf6af40","5ab0f55fade4f4003cf6af41","5ab0f55fade4f4003cf6af42","5ab0f55fade4f4003cf6af43","5ab0f55fade4f4003cf6af44","5ab0f55fade4f4003cf6af45","5ab0f55fade4f4003cf6af46","5ab0f55fade4f4003cf6af47"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__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":43,"body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`firstName`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Shopper's first name.\\nMaximum 100 characters.\",\n \"1-0\": \"`lastName`\",\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](/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 \"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\": \"`shopperCurrency`\",\n \"14-0\": \"`paymentSources`\",\n \"19-0\": \"`transactionFraudInfo`\",\n \"12-1\": \"*string*\",\n \"14-1\": \"*object* \",\n \"19-1\": \"*object*\",\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\": \"See [paymentSources](doc:payment-sources).\",\n \"19-3\": \"See [transactionFraudInfo](doc:transaction-fraud-info).\",\n \"15-0\": \"`shippingContactInfo`\",\n \"15-1\": \"*object*\",\n \"15-2\": \"Optional\",\n \"15-3\": \"See [shippingContactInfo](doc:shipping-contact-info).\",\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\": \"*object*\",\n \"18-0\": \"`walletId`\",\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\": \"`personalIdentificationNumber`\",\n \"13-1\": \"*string*\",\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 * Colombia - CC (length 6-10 chars)\\n * Mexico - CURP/RFC (length 10-18 chars)\",\n \"13-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) in Brazil\",\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\": \"`merchantShopperId`\",\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\": \"`companyName`\",\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\": \"`softDescriptor`\",\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\": \"`descriptorPhoneNumber`\",\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 },\n \"cols\": 4,\n \"rows\": 20\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\": \"`firstName`\",\n \"1-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"1-3\": \"Cardholder's first name.\",\n \"2-0\": \"`lastName`\",\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 \"3-0\": \"`country`\",\n \"3-1\": \"*string*\",\n \"4-0\": \"`state`\",\n \"5-0\": \"`address`\",\n \"4-3\": \"Cardholder's state code.\\n\\nADD LINK TO LIST OF STATE CODES\",\n \"4-1\": \"*string*\",\n \"5-1\": \"*string*\",\n \"8-0\": \"`zip`\",\n \"8-1\": \"*string*\",\n \"9-0\": \"`phone`\",\n \"5-3\": \"Cardholder's address.\",\n \"3-3\": \"Cardholder's country code.\\n\\nADD LINK TO LIST OF COUNTRY CODES\",\n \"3-2\": \"Shopper's country code.\\nSee [Country codes](/docs/country-codes)\",\n \"4-2\": \"Shopper's state code.\\nSee [State and province codes](/docs/state-and-province-codes)\",\n \"5-2\": \"Shopper's address line 1.\\nMaximum 100 characters.\",\n \"8-2\": \"Shopper's ZIP code.\",\n \"9-2\": \"Shopper's phone number.\\nBetween 2-36 characters.\",\n \"9-3\": \"Cardholder's phone number.\",\n \"8-3\": \"Cardholder's ZIP code.\",\n \"9-1\": \"*string*\",\n \"7-0\": \"`email`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Shopper's email address.\\nBetween 3-100 characters.\",\n \"11-2\": \"Shopper's currency. See [Currency codes](/docs/currency-codes).\",\n \"15-2\": \"See [paymentSources](doc:payment-sources).\",\n \"18-2\": \"See [transactionFraudInfo](doc:transaction-fraud-info).\",\n \"18-1\": \"*object*\",\n \"15-1\": \"*object*\",\n \"11-1\": \"*string*\",\n \"11-0\": \"`shopperCurrency`\",\n \"15-0\": \"`paymentSources`\",\n \"18-0\": \"`transactionFraudInfo`\",\n \"17-2\": \"See [shippingContactInfo](doc:shipping-contact-info).\",\n \"17-1\": \"*object*\",\n \"17-0\": \"`shippingContactInfo`\",\n \"19-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n \"19-1\": \"*object*\",\n \"19-0\": \"`fraudResultInfo`\",\n \"16-2\": \"See [lastPaymentInfo](doc:last-payment-info).\",\n \"16-1\": \"*object*\",\n \"16-0\": \"`lastPaymentInfo`\",\n \"6-0\": \"`address2`\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Shopper's address line 2.\\nMaximum 100 characters.\",\n \"0-1\": \"*integer*\",\n \"0-0\": \"`vaultedShopperId`\",\n \"0-2\": \"ID of an existing vaulted shopper.\",\n \"12-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 * Colombia - CC (length 6-10 chars)\\n * Mexico - CURP/RFC (length 10-18 chars)\",\n \"12-0\": \"`personalIdentificationNumber`\",\n \"12-1\": \"*string*\",\n \"10-0\": \"`companyName`\",\n \"10-1\": \"*string*\",\n \"10-2\": \"Shopper's company name\",\n \"13-0\": \"`softDescriptor`\",\n \"13-1\": \"*string*\",\n \"13-2\": \"Description that may appear on the shopper's bank statement when BlueSnap validates the card.\",\n \"14-0\": \"`descriptorPhoneNumber`\",\n \"14-1\": \"*string*\",\n \"14-2\": \"Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card.\"\n },\n \"cols\": 3,\n \"rows\": 20\n}\n[/block]","excerpt":"Contains information about the vaulted shopper","slug":"vaulted-shopper","type":"basic","title":"vaultedShopper"}

Request

Property Name

Type

Required

Description

firstName

string

Required

Shopper's first name.
Maximum 100 characters.

lastName

string

Required

Shopper's last name.
Maximum 100 characters.

merchantShopperId

string

Optional

A merchant's ID for a specific shopper, up to 50 characters.

country

string

Optional

Shopper's country code.
See Country codes

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.
Between 3-100 characters.

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: + . * # / \ ( ) -

companyName

string

Required for Corporate ECP accounts.

Shopper's company name. Maximum 100 characters.

shopperCurrency

string

Optional

Shopper's currency. See Currency codes.

personalIdentificationNumber

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)
Colombia - CC (length 6-10 chars)
Mexico - CURP/RFC (length 10-18 chars)

paymentSources

object

Optional

See paymentSources.

shippingContactInfo

object

Optional

See shippingContactInfo.

softDescriptor

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.

descriptorPhoneNumber

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.

walletId

object

Optional

ID of the wallet, obtained via the Create Wallet request.

Note: Applicable for MasterPass and Visa Checkout.

transactionFraudInfo

object

Optional

See transactionFraudInfo.

Response

Property Name

Type

Description

vaultedShopperId

integer

ID of an existing vaulted shopper.

firstName

string

Shopper's first name.
Maximum 100 characters.

lastName

string

Shopper's last name.
Maximum 100 characters.

country

string

Shopper's country code.
See Country codes

state

string

Shopper's state code.
See State and province codes

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.
Between 3-100 characters.

zip

string

Shopper's ZIP code.

phone

string

Shopper's phone number.
Between 2-36 characters.

companyName

string

Shopper's company name

shopperCurrency

string

Shopper's currency. See Currency codes.

personalIdentificationNumber

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)
Colombia - CC (length 6-10 chars)
Mexico - CURP/RFC (length 10-18 chars)

softDescriptor

string

Description that may appear on the shopper's bank statement when BlueSnap validates the card.

descriptorPhoneNumber

string

Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card.

paymentSources

object

See paymentSources.

lastPaymentInfo

object

See lastPaymentInfo.

shippingContactInfo

object

See shippingContactInfo.

transactionFraudInfo

object

See transactionFraudInfo.

fraudResultInfo

object

See fraudResultInfo.

BlueSnap Developer Hub

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

Request

Response