vaultedShopper

Request

Property Name	Type	Required	Description
`address`	string	Optional	Shopper's address line 1. Maximum 100 characters.
`address2`	string	Optional	Shopper's address line 2. Maximum 100 characters.
`chosenPaymentMethod`	object	Optional; Only relevant for Update Vaulted Shopper requests	See chosenPaymentMethod.
`city`	string	Optional	Shopper's city. Between 2-42 characters.
`country`	string	Optional	Shopper's country code. See Country codes
`companyName`	string	Required for Corporate ECP accounts.	Shopper's company name. Maximum 100 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.
`email`	string	Optional	Shopper's email address.
`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.
`paymentSources`	object	Optional	See paymentSources.
`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)
`phone`	string	Optional	Shopper's phone number. Between 2-36 characters. Accepts numbers, letters, and these characters: + .* # / \ ( ) -
`shippingContactInfo`	object	Optional	See shippingContactInfo.
`shopperCurrency`	string	Optional	Shopper's currency. See Currency codes.
`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.
`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.
`threeDSecure`	object	Optional	See threeDSecure.
`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.
`walletId`	object	Optional	ID of the wallet, obtained via the Create Wallet request. Note: Applicable for Visa Checkout.
`zip`	string	Optional	Shopper's ZIP code. Maximum 20 characters.

Response

Property Name	Type	Description
`address`	string	Shopper's address line 1. Maximum 100 characters.
`address2`	string	Shopper's address line 2. Maximum 100 characters.
`chosenPaymentMethod`	object	See chosenPaymentMethod.
`companyName`	string	Shopper's company name
`country`	string	Shopper's country code. See Country codes
`dateCreated`	string	The date the vaulted shopper was created.
`descriptorPhoneNumber`	string	Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card.
`email`	string	Shopper's email address.
`firstName`	string	Shopper's first name. Maximum 100 characters.
`fraudResultInfo`	object	See fraudResultInfo.
`lastName`	string	Shopper's last name. Maximum 100 characters.
`lastPaymentInfo`	object	See lastPaymentInfo.
`paymentSources`	object	See paymentSources.
`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)
`phone`	string	Shopper's phone number. Between 2-36 characters.
`shippingContactInfo`	object	See shippingContactInfo.
`shopperCurrency`	string	Shopper's currency. See Currency codes.
`softDescriptor`	string	Description that may appear on the shopper's bank statement when BlueSnap validates the card.
`state`	string	Shopper's state code. See State and province codes
`threeDSecure`	object	See threeDSecure.
`timeCreated`	string	The time (PST) the vaulted shopper was created.
`transactionFraudInfo`	object	See transactionFraudInfo.
`vaultedShopperId`	integer	ID of an existing vaulted shopper.
`zip`	string	Shopper's ZIP code.