Shopper
This is a JSON object with the following fields:
| Field |
Type |
Required |
Description |
| name |
String(80) |
yes |
Name of the Cardholder. |
| account |
Object |
yes |
Object containing information about the user’s account in your platform. (see Account Object) |
| email |
String(10) 0 |
yes |
Customer’s email |
| address1 |
String(50) |
yes |
First line of the street address |
| address2 |
String(50) |
no |
Second line of the street address |
| address3 |
String(50) |
no |
Thid line of the street address |
| zipcode |
String(16) |
no |
ZIP or other postal code of the Cardholder |
| city |
String(50) |
yes |
The city of the Cardholder |
| state |
String(30) |
yes |
The state or province of the Cardholder. ISO-3166-2 state codes. |
| countryCode |
String(2) |
yes |
ISO-3166-1 country codes. |
| homePhonePrefix |
String(4) |
no |
Country prefix of cardholder’s home phone |
| homePhone |
String(20) |
no |
Cardholder’s home phone |
| mobilePhonePrefix |
String(4) |
no |
Country prefix of cardholder’s mobile phone |
| mobilePhone |
String(20) |
no |
Cardholder’s mobile phone |
| workPhonePrefix |
String(4) |
no |
Country prefix of cardholder’s work phone |
| workPhone |
String(20) |
no |
Cardholder’s work phone |
Account Object
Structure that stores the information of the account of the shopper.
| Field |
Type |
Required |
Description |
| age |
String(2) |
yes |
Length of time that the cardholder has had the account with the website. Possible values |
| date |
String(8) |
yes |
Date that the cardholder opened the account with the website. Date format = YYYYMMDD |
| lastChange |
String(2) |
yes |
Length of time since the cardholder’s account information with the website was last changed. Possible values |
| lastChangeDate |
String(8) |
yes |
Date that the cardholder’s account with the website was last changed. Date format = YYYYMMDD. |
| pwChange |
String(2) |
yes |
Length of time since the cardholder’s account with the website had a password change or account reset. Possible values |
| pwChangeDate |
String(8) |
yes |
Date that cardholder’s account with the website had a password change or account reset. Date format must be YYYYMMDD. |
| shipInfoAge |
String(2) |
yes |
Indicates when the shipping address used for this transaction was first used with the website. Possible values |
| shipInfoDate |
String(8) |
yes |
Date when the shipping address used for this transaction was first used with the website. Date format must be YYYYMMDD. |
| transLastDay |
Integer(6) |
yes |
Number of transactions (successful and abandoned) for this cardholder account with the website across all payment accounts in the previous 24 hours. |
| transLastYear |
Integer(6) |
yes |
Number of transactions (successful and abandoned) for this cardholder account with the website across all payment accounts in the previous year. |
| cardsAddLastDay |
Integer(6) |
yes |
Number of Add Card attempts in the last 24 hours. |
| orderSixMonths |
Integer(6) |
yes |
Number of purchases with this cardholder account during the previous six months. |
| suspicious |
Boolean |
yes |
Indicates whether the website has experienced suspicious activity (including previous fraud) on the cardholder account. |
| namesMatching |
Boolean |
yes |
Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. |
| paymentMeanAge |
String(2) |
yes |
Indicates the length of time that the payment account was enrolled in the cardholder’s account with the website. Possible values |
| paymentMeanDate |
String(8) |
yes |
Date that the payment account was enrolled in the cardholder’s account with the website. Date format must be YYYYMMDD. |
Account age
| Accepted values |
Description |
| 01 |
No account |
| 02 |
Created during this transaction |
| 03 |
Less than 30 days |
| 04 |
Between 30 and 60 days |
| 05 |
More than 60 days |
Account last modified
| Accepted values |
Description |
| 01 |
Changed during this transaction |
| 02 |
Less than 30 days |
| 03 |
Between 30 and 60 days |
| 04 |
More than 60 days |
Password last modified
| Accepted values |
Description |
| 01 |
No change |
| 02 |
Changed during this transaction |
| 03 |
Less than 30 days |
| 04 |
30 - 60 days |
| 05 |
More than 60 days |
Shipping info age
| Accepted values |
Description |
| 01 |
This transaction |
| 02 |
Less than 30 days |
| 03 |
30 - 60 days |
| 04 |
More than 60 days |
Payment mean age
| Accepted values |
Description |
| 01 |
No account (guest checkout) |
| 02 |
Created during this transaction |
| 03 |
Less than 30 days |
| 04 |
Between 30 and 60 days |
| 05 |
More than 60 days |