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 your risk configuration, we recommend that you collect and then send in as many fields as possible in your payment request. Doing this ensures that you trigger the risk checks, as these checks depend on specific fields being present in the request. Sending in more fields will also help our risk engine to make intelligent decisions based on properties connected to a payment.
For Web Drop-in/Components integrations, we collect additional shopper data that you send when the shopper pays, with the option for more data collection outside of the checkout page.
Fields required for risk checks
The following is a list of API fields that are required for some of our risk checks:
Field | Required for | API reference |
---|---|---|
billingAddress |
|
/sessions /payments /authorise |
deliveryAddress |
|
/sessions /payments /authorise |
shopperEmail |
|
/sessions /payments /authorise |
shopperIP |
The shopperIP is retrieved automatically if you are using our simplified Web Drop-in or Web Components integration. |
/sessions /payments /authorise |
shopperName |
|
/sessions /payments /authorise |
shopperReference |
|
/sessions /payments /authorise |
telephoneNumber |
|
/sessions /payments /authorise |
Extra fields for specific cases
The following table shows a number of API fields that you can use for specific risk checks or your own, custom risk setup.
Field | Required for | API reference |
---|---|---|
accountInfo.accountCreationDate |
Required if you want to use the creation date option as the source for the shopper account age consistency check, or in custom rules. To use this field, you must provide the account creation date as part of the payment request. Although the accountInfo object is used for 3D Secure transactions, you can also use this object to include the accountCreationDate in your payment request. |
/sessions /payments /authorise |
additionalData.riskdata.deliveryMethod |
Required if you want to use the delivery method consistency check. You can configure the values for the deliveryMethod field in the risk rule configuration for the delivery method check. |
/payments /authorise |
browserInfo |
Required for 3D Secure transactions, but you can also use this field in your custom rules or lists. | /payments /authorise |
deliveryDate |
Required if you want to use the time to delivery consistency check, or if you want to use the field hoursToDelivery in a custom risk rule. |
/payments /authorise |
Collect additional risk data
For Web Drop-in/Components integrations, we collect additional data to detect fraud.
In addition to the data that you send when the shopper checks out, you can also optionally collect data to detect fraud outside of the checkout page. We recommend that you collect data about the shopper's activity on every page of your site.
To do this, add the following script to any of your web pages.
When the shopper checks out, Drop-in or the Component sends all of the data collected by the script to Adyen. This includes the data from the checkout page as well as any data collected from other web pages that contain the script.
If your integration uses the Advanced flow, you must include the following in the /payments request.
Field | Required for | API reference |
---|---|---|
riskData |
Required to send device characteristics and other data that we use to detect fraudulent payment activity, and mitigate fraud. If you collect additional data from other pages on your website, that data is also included in this object. | /payments |