vaultedShopper

Contains information about the vaulted shopper

Request

Property Name	Type	Required	Description
firstName	string	Required	Shopper's first name. Maximum 100 characters. For ACH/ECP, the limit is 25 characters.
lastName	string	Required	Shopper's last name. Maximum 100 characters. For ACH/ECP, the limit is 25 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.
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) 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 Visa Checkout.
transactionFraudInfo	object	Optional	See transactionFraudInfo.
transactionOrderSource	string	Optional	Identifies the order type. The only option is MOTO  (Mail Order Telephone Order). Any other option is ignored.
threeDSecure	object	Optional	See threeDSecure.
chosenPaymentMethod	object	Optional; Only relevant for Update Vaulted Shopper requests	See chosenPaymentMethod.

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.
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) 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.
threeDSecure	object	See threeDSecure.
chosenPaymentMethod	object	See chosenPaymentMethod.
dateCreated	string	The date the vaulted shopper was created.
timeCreated	string	The time (PST) the vaulted shopper was created.