vaulted-shopper

Contains information about the vaulted shopper

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.

city

string

Optional

Shopper's city.
Between 2-42 characters.

company-name

string

Required for Corporate ECP accounts.

Shopper's company name. Maximum 100 characters.

country

string

Optional

Shopper's country code.
See Country codes

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.

email

string

Optional

Shopper's email address.

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.

payment-sources

container

Optional

Container of payment-sources properties.

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

shipping-contact-info

container

Optional

Container of shipping-contact-info properties.

shopper-currency

string

Optional

Shopper's currency. See Currency codes.

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.

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.

transaction-fraud-info

container

Optional

Container of transaction-fraud-info

wallet-id

container

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