vaulted-shopper

Contains information about the vaulted shopper

Request

Property NameTypeRequiredDescription
first-namestringRequiredShopper's first name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.
last-namestringRequiredShopper's last name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.
merchant-shopper-idstringOptionalA merchant's ID for a specific shopper, up to 50 characters.
countrystringOptionalShopper's country code.
See Country codes
statestringOptionalShopper'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.
citystringOptionalShopper's city.
Between 2-42 characters.
addressstringOptionalShopper's address line 1.
Maximum 100 characters.
address2stringOptionalShopper's address line 2.
Maximum 100 characters.
emailstringOptionalShopper's email address.
zipstringOptionalShopper's ZIP code. Maximum 20 characters.
phonestringOptionalShopper's phone number.
Between 2-36 characters.
Accepts numbers, letters, and these characters: + . * # / \ ( ) -
company-namestringRequired for Corporate ECP accounts.Shopper's company name. Maximum 100 characters.
shopper-currencystringOptionalShopper's currency. See Currency codes.
personal-identification-numberstringRequired for local LatAm processing in BrazilThe 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)
payment-sourcescontainerOptionalContainer of payment-sources properties.
shipping-contact-infocontainerOptionalContainer of shipping-contact-info properties.
soft-descriptorstringOptional; Relevant if sending a credit card numberDescription that may appear on the shopper's bank statement when BlueSnap validates the card. Maximum 20 characters.
descriptor-phone-numberstringOptional; Relevant if sending a credit card numberMerchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card. Maximum 20 characters.
wallet-idcontainerOptionalID of the wallet, obtained via the Create Wallet request.

Note: Applicable for Visa Checkout.
transaction-fraud-infocontainerOptionalContainer of transaction-fraud-info properties.
transaction-order-sourcestringOptionalIdentifies the order type.
The only option is MOTO  (Mail Order Telephone Order).
Any other option is ignored.
three-d-securecontainerOptionalContainer of three-d-secure properties.
chosen-payment-methodcontainerOptional; Only relevant for Update Vaulted Shopper requestsContainer of chosen-payment-method properties.

Response

Property NameTypeDescription
vaulted-shopper-idintegerID of an existing vaulted shopper.
first-namestringShopper's first name.
Maximum 100 characters.
last-namestringShopper's last name.
Maximum 100 characters.
merchant-shopper-idstringA merchant's ID for a specific shopper, up to 50 characters.
countrystringShopper's country code.
See Country codes
statestringShopper's state code.
See State and province codes
addressstringShopper's address line 1.
Maximum 100 characters.
address2stringShopper's address line 2.
Maximum 100 characters.
emailstringShopper's email address.
zipstringShopper's ZIP code.
phonestringShopper's phone number.
Between 2-36 characters.
company-namestringShopper's company name
shopper-currencystringShopper's currency. See Currency codes.
personal-identification-numberstringThe 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-descriptorstringDescription that may appear on the shopper's bank statement when BlueSnap validates the card.
descriptor-phone-numberstringMerchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card.
payment-sourcescontainerContainer of payment-sources properties.
last-payment-infocontainerContainer of last-payment-info properties.
shipping-contact-infocontainerContainer of shipping-contact-info properties.
fraud-result-infocontainerContainer of fraud-result-info properties.
three-d-securecontainerContainer of three-d-secure properties.
chosen-payment-methodcontainerContainer of chosen-payment-method properties.
date-createdstringThe date the vaulted shopper was created.
time-createdstringThe time (PST) the vaulted shopper was created.