Shopper details

Add details about the shopper involved in the transaction.

Add shopper details

To include shopper details, add the following snippet to your card transaction request.

{
  "shopper": {
    "dateOfBirth": "27/01/1990",
    "email": "[email protected]",
    "firstName":"John",
    "lastName": "Doe",
    "id": "Shopper_01",
    "houseNumberOrName": "10",
    "street": "Downing Street",
    "city": "London",
    "postalCode": "SW1A 2AA",
    "state": "CA",
    "countryCode": "GB"
  }
}
PropertyDescription
shopper
object
Details about the shopper.
shopper.dateOfBirth
string (10 characters)
The date of birth of the shopper. Format should be YYYY-MM-DD.
shopper.address
string (≤ 100 characters)
The email address of the shopper.
shopper.firstName
string (≤ 100 characters)
The first name of the shopper.
shopper.lastName
string (≤ 100 characters)
The last name of the shopper.
shopper.id
string (≤ 50 characters)
The unique identifier of the shopper. Format should be ^\[A-Za-z0-9 \_-]+$.
shopper.houseNumberOrName
string (≤ 100 characters)
The house number or name associated with the shopper's address.
shopper.street
string (≤ 100 characters)
The street associated with the shopper's address.
shopper.city
string
The city associated with the shopper's address.
shopper.postalCode
string (≤ 10 characters)
The postal or ZIP code of the shopper's address. This field accepts up to 5 digits for US addresses or up to 10 characters for addresses in other countries, accommodating global variations in postal code formats.
shopper.state
string (2 characters)
The state or province associated with the shopper's address, in ISO 3166-2 format.
shopper.countryCode
string (2 characters)
The country code of the shopper's address, in ISO-3166-1 alpha-2 format.
shopper.phoneNumber
string (≤ 50 characters)
The shopper's phone number.