{"title":"Required risk field reference","category":"default","creationDate":1780579041,"content":"

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<\/code> and reference<\/code>. Other fields such as shopperIP<\/code>, shopperReference<\/code> and shopperEmail<\/code> are not always required, but strongly recommended to include.<\/p>\n

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.<\/p>\n

For Web Drop-in\/Components integrations, we collect additional shopper data<\/a> that you send when the shopper pays, with the option for more data collection outside of the checkout page.<\/p>\n

Fields required for risk checks<\/h2>\n

The following is a list of API fields that are required for some of our risk checks:<\/p>\n

\n \n\n\n\n\n\n\n\n\n\n\n\n
Field<\/th>\nRequired for<\/th>\nAPI reference<\/th>\n<\/tr>\n<\/thead>\n
billingAddress<\/code><\/td>\n

Block and trust lists<\/a>

\/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
deliveryAddress<\/code><\/td>\n

Block and trust lists<\/a>

\/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
shopperEmail<\/code><\/td>\n

Block and trust lists<\/a>

 \/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
shopperIP<\/code><\/td>\n

Block and trust lists<\/a>

 \/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
shopperName<\/code><\/td>\n

Block and trust lists<\/a>

\/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
shopperReference<\/code><\/td>\n

Block and trust lists<\/a>

\/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
telephoneNumber<\/code><\/td>\n

Block and trust lists<\/a>

\/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n

Extra fields for specific cases<\/h2>\n

The following table shows a number of API fields that you can use for specific risk checks or your own, custom risk setup.<\/p>\n

\n \n\n\n\n\n\n\n\n\n
Field<\/th>\nRequired for<\/th>\nAPI reference<\/th>\n<\/tr>\n<\/thead>\n
accountInfo.accountCreationDate<\/code><\/td>\nRequired if you want to use the creation date option as the source for the shopper account age consistency check<\/a>, or in custom rules<\/a>.
To use this field, you must provide the account creation date as part of the payment request.
Although the accountInfo<\/code> object is used for 3D Secure transactions, you can also use this object to include the accountCreationDate<\/code> in your payment request.<\/td>\n		 \/sessions<\/a>
\/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
additionalData.riskdata.deliveryMethod<\/code><\/td>\nRequired if you want to use the delivery method consistency check<\/a>.
You can configure the values for the deliveryMethod<\/code> field in the risk rule configuration for the delivery method check.<\/td>\n		 \/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
browserInfo<\/code><\/td>\nRequired for 3D Secure transactions, but you can also use this field in your custom rules or lists<\/a>.<\/td>\n \/payments<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n
deliveryDate<\/code> (Checkout API v69 or earlier)
deliverAt<\/code> (Checkout API v70 or later)<\/td>\n		Required if you want to use the time to delivery consistency check<\/a>, or if you want to use the field hoursToDelivery<\/code> in a custom risk rule<\/a>.<\/td>\n deliveryDate<\/a>
deliverAt<\/a>
\/authorise<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n

Collect additional risk data<\/h2>\n

For Web Drop-in\/Components<\/a> integrations, we collect additional data to detect fraud<\/a>.<\/p>\n \n

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.<\/p>\n \n

To do this, add the following script to any of your web pages.<\/p>\n

\n <\/code-sample>\n<\/div>\n

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.<\/p>\n

If your integration uses the Advanced flow, you must include the following in the \/payments<\/a> request.<\/p>\n\n\n\n\n\n
Field<\/th>\nRequired for<\/th>\nAPI reference<\/th>\n<\/tr>\n<\/thead>\n
riskData<\/code><\/td>\nRequired to send device characteristics and other data<\/a> 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.<\/td>\n\/payments<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/risk-management\/configure-manual-risk\/required-risk-field-reference","articleFields":{"description":"Learn which fields to include in your payments request to trigger risk checks","robots":"noindex,nofollow","id":"25135165","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"06-09-2019 14:25","parameters":{"section":"risk"}},"algolia":{"url":"https:\/\/docs.adyen.com\/risk-management\/configure-manual-risk\/required-risk-field-reference","title":"Required risk field reference","content":"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.\nTo 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.\nFor 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.\nFields required for risk checks\nThe following is a list of API fields that are required for some of our risk checks:\n\n \n\n\n\nField\nRequired for\nAPI reference\n\n\n\n\nbillingAddress\nBlock and trust lists Shopper address referral listConsistency rulesBilling address differs from delivery addressBilling address does not match cardholder address (AVS)\n \/sessions\/payments\/authorise\n\n\ndeliveryAddress\nBlock and trust listsShopper address referral listConsistency rulesBilling address differs from delivery addressShopperDNA rules Multiple distinct delivery addresses used by shopperCustom Custom rulesCustom lists\n\/sessions\/payments\/authorise\n\n\nshopperEmail\nBlock and trust listsEmail domain referral checkShopper email referral checkConsistency rulesPayPal auth-result emailEmail address and shopper name comparisonEmail is likely to be fake or automatically generatedShopperDNA rules Multiple distinct email addresses used by shopperVelocity rulesShopper initiated a transaction more than X times within a time periodShopper email used more than X times within a time periodCustom Custom rulesCustom lists\n \/sessions\/payments \/authorise\n\n\nshopperIP\nBlock and trust listsShopper IP referral checkConsistency rulesShopper IP originates from high-risk countryShopper country differs from issuing countryShopperDNA rulesMultiple distinct IP addresses used by shopperShopper used shared IP addressVelocity rulesShopper initiated a transaction more than X times within a time periodShopper IP used more than X times within a time periodCustom Custom rulesCustom lists The shopperIP is retrieved automatically if you are using our simplified Web Drop-in or Web Components integration.\n \/sessions\/payments\/authorise\n\n\nshopperName\nBlock and trust listsShopper name referral checkConsistency rulesEmail address and shopper name comparisonCustom Custom rulesCustom lists\n\/sessions \/payments\/authorise\n\n\nshopperReference\nBlock and trust listsShopper reference referral checkShopperDNA rulesMultiple distinct shopper references used by shopperVelocity rulesCard\/Bank account number already used by another shopperDifferent cards\/bank accounts used by the same shopperCustom Custom lists\n\/sessions\/payments\/authorise\n\n\ntelephoneNumber\nBlock and trust listsTelephone number referral checkConsistency rulesEmail address and shopper name comparisonCustom Custom rulesCustom lists\n\/sessions\/payments \/authorise\n\n\n\n\n\n\nExtra fields for specific cases\nThe following table shows a number of API fields that you can use for specific risk checks or your own, custom risk setup.\n\n \n\n\n\nField\nRequired for\nAPI reference\n\n\n\n\naccountInfo.accountCreationDate\nRequired 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.\n \/sessions\/payments \/authorise\n\n\nadditionalData.riskdata.deliveryMethod\nRequired 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.\n \/payments\/authorise\n\n\nbrowserInfo\nRequired for 3D Secure transactions, but you can also use this field in your custom rules or lists.\n \/payments \/authorise\n\n\ndeliveryDate (Checkout API v69 or earlier)deliverAt (Checkout API v70 or later)\nRequired 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.\n deliveryDate deliverAt\/authorise\n\n\n\n\n\n\nCollect additional risk data\nFor Web Drop-in\/Components integrations, we collect additional data to detect fraud.\n \nIn 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.\n \nTo do this, add the following script to any of your web pages.\n\n \n\nWhen 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.\nIf your integration uses the Advanced flow, you must include the following in the \/payments request.\n\n\n\nField\nRequired for\nAPI reference\n\n\n\n\nriskData\nRequired 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.\n\/payments\n\n\n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Risk management","lvl2":"Configure classic risk profiles","lvl3":"Required risk field reference"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/risk-management","lvl2":"https:\/\/docs.adyen.com\/risk-management\/configure-manual-risk","lvl3":"\/risk-management\/configure-manual-risk\/required-risk-field-reference"},"levels":4,"category":"Risk Management","category_color":"green","tags":["Required","field","reference"]}}