Shopper


Structure that stores the information of the shopper for a transaction attempts.

Name Type Required Description API Version
id String(32) no The unique identification number of the shopper >= 002.50
name String(80) yes The name provided by the shopper < 002.70
firstName String(35) yes The firstname provided by the shopper >= 002.70
lastName String(35) yes The lastname provided by the shopper >= 002.70
email String(100) yes The email address provided by the shopper >= 002.50
account Account yes Object containing information about the user’s account in your platform. >= 002.70
address1 String(50) yes The address provided by the shopper. Use only address for API <= 002.62 >= 002.50
address2 String(50) no The address second line. >= 002.70
address3 String(50) no The address third line. >= 002.70
zipcode String(16) yes The zip code provided by the shopper >= 002.50
city String(50) yes The city provided by the shopper >= 002.50
state String(3) yes The state provided by the shopper >= 002.50
countryCode String(2) yes ISO-3166-1 country codes. >= 002.50
phone String(20) no The phone number provided by the shopper >= 002.50
<= 002.62
homePhonePrefix String(4) yes Country prefix of shopper’s home phone >= 002.70
homePhone String(20) yes Shopper’s home phone >= 002.70
mobilePhonePrefix String(4) no Country prefix of shopper’s mobile phone >= 002.70
mobilePhone String(20) no Shopper’s mobile phone >= 002.70
workPhonePrefix String(4) no Country prefix of shopper’s work phone >= 002.70
workPhone String(20) no Shopper’s work phone >= 002.70
company String(128) no Shopper’s company >= 002.70
birthDate String(8) no Date of shopper birth date, format YYYYMMDD >= 002.50
idNumber String(32) no Shopper official document identifier (passport number, ID number, taxpayer ID…) >= 002.50