Contains information about the vaulted shopper
Request
Property Name | Type | Required | Description |
---|---|---|---|
| string | Required | Shopper's first name. Maximum 100 characters. For ACH/ECP, the limit is 25 characters. |
| string | Required | Shopper's last name. Maximum 100 characters. For ACH/ECP, the limit is 25 characters. |
| string | Optional | A merchant's ID for a specific shopper, up to 50 characters. |
| string | Optional | Shopper's country code. See Country codes |
| 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 |
| string | Optional | Shopper's city. Between 2-42 characters. |
| string | Optional | Shopper's address line 1. Maximum 100 characters. |
| string | Optional | Shopper's address line 2. Maximum 100 characters. |
| string | Optional | Shopper's email address. |
| string | Optional | Shopper's ZIP code. Maximum 20 characters. |
| string | Optional | Shopper's phone number. Between 2-36 characters. Accepts numbers, letters, and these characters: + . * # / \ ( ) - |
| string | Required for Corporate ECP accounts. | Shopper's company name. Maximum 100 characters. |
| string | Optional | Shopper's currency. See Currency codes. |
| string | Required for local LatAm processing in Brazil | The shopper's local personal identification number. These are the ID types per country:
|
| container | Optional | Container of payment-sources properties. |
| container | Optional | Container of shipping-contact-info properties. |
| 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. |
| 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. |
| container | Optional | ID of the wallet, obtained via the Create Wallet request. Note: Applicable for Visa Checkout. |
| container | Optional | Container of transaction-fraud-info properties. |
| string | Optional | Identifies the order type. |
| container | Optional | Container of three-d-secure properties. |
| container | Optional; Only relevant for Update Vaulted Shopper requests | Container of chosen-payment-method properties. |
Response
Property Name | Type | Description |
---|---|---|
| integer | ID of an existing vaulted shopper. |
| string | Shopper's first name. Maximum 100 characters. |
| string | Shopper's last name. Maximum 100 characters. |
| string | A merchant's ID for a specific shopper, up to 50 characters. |
| string | Shopper's country code. See Country codes |
| string | Shopper's state code. See State and province codes |
| string | Shopper's address line 1. Maximum 100 characters. |
| string | Shopper's address line 2. Maximum 100 characters. |
| string | Shopper's email address. |
| string | Shopper's ZIP code. |
| string | Shopper's phone number. Between 2-36 characters. |
| string | Shopper's company name |
| string | Shopper's currency. See Currency codes. |
| string | The shopper's local personal identification number. These are the ID types per country:
|
| string | Description that may appear on the shopper's bank statement when BlueSnap validates the card. |
| string | Merchant's support phone number that may appear on the shopper's bank statement when BlueSnap validates the card. |
| container | Container of payment-sources properties. |
| container | Container of last-payment-info properties. |
| container | Container of shipping-contact-info properties. |
| container | Container of fraud-result-info properties. |
| container | Container of three-d-secure properties. |
| container | Container of chosen-payment-method properties. |
| string | The date the vaulted shopper was created. |
| string | The time (PST) the vaulted shopper was created. |