Data quality and risk field reference

Learn which fields to include in your payment request to improve the risk evaluation, and trigger risk rules.

You include a variety of fields when you send in a payment request. Some of these fields are mandatory to make a payment, for example amount and reference. Other fields such as shopperIP, shopperReference and shopperEmail are not always required, but strongly recommended to include.

To get the most benefit out of Protect, we recommend that you collect and then send in as many fields as possible in your payment request.

Data quality

Machine learning predicts the likelihood of a transaction being fraudulent based on the data in the payment request, historical shopper data, and interaction patterns with the payment form.

For both the rules Machine learning: fraud risk and Machine learning: bot attack risk, it is important to provide high quality data to reach the most correct risk classification. Similarly, when you use risk lists or custom rules, the payment request has to contain the data to trigger the correct action.

You can influence the quality of the data. We recommend that you always send in as many fields as possible, and avoid sending in dummy or placeholder data.

If you use a Web Drop-in/Components integration, we collect additional risk data that you send when the shopper pays, with the option for more data collection outside of the checkout page. If you have built a Web API-only integration, you can also collect this data and then send it in your payment request.

The following table shows some example fields that are highly relevant for the risk evaluation.

Data point	Used by	Required field in payment request
Billing address	Default Shopper address risk lists Machine learning rules	`billingAddress`
Delivery address	Default Shopper address risk lists Machine learning rules Custom rules and custom lists	`deliveryAddress`
Email address	Default Shopper email and Email domain risk lists Machine learning rules Custom rules and custom lists	`shopperEmail`
IP address	Default Shopper IP address risk lists Machine learning rules Custom rules and custom lists Data collection: device information	`shopperIP`
The shopper’s first and last name	Default Shopper name risk lists Custom rules and custom lists Machine learning rules	`shopperName`
Your reference to uniquely identify the shopper	Default Shopper reference risk lists Custom lists	`shopperReference`
The shopper’s phone number	Default Phone number risk lists Custom rules and custom lists Machine learning rules	`telephoneNumber`
Card number	Default Bank identification number (BIN) risk lists Default Fraudulent card number or bank account number (IBAN) block risk list Default Non-fraudulent card number or bank account number (IBAN) block risk list Default Card number or bank account number (IBAN) trust risk list Machine learning rules	`paymentMethod.number` `paymentMethod.encryptedCardNumber`
The account creation date	Custom rules	`accountInfo.accountCreationDate`
Browser information	Custom rules and custom lists Data collection: device information Machine learning rules	`browserInfo`
The date and time that the item will be delivered	Custom rules: include if you want to use the `hoursToDelivery` field.	Checkout API v69 or earlier: `deliveryDate` Checkout API v70 or later: `deliverAt`
Risk data for Web API-only and additional risk data for Web Drop-in/Components	Machine learning rules	`riskData`

Data quality and risk field reference

Data quality

See also