Provide data for risk checks

Many risk checks require you to provide additional information on the payment to perform better assessment of the transaction. For this, make sure that you submit all required fields, as shown in this document.

Adyen also allows you to include basket and promotion information, useful when performing case management or transactions capturing. Use these fields within the additionalData object. For more information, refer to Basket content fields and Promotion content fields.

Standard fields

The standard risk fields comprise the minimum data points required to use our risk system:

Field Required Description
reference (tick)

A unique identifier associated to a specific transaction. It is used in all communication with you regarding the status of the payment.

We recommend using a unique value per payment, but this is not a requirement.

shopperReference (error)

A shopper's reference, which is the unique identifier for a shopper.

Required for the following risk checks:

dateOfBirth (error)

The shopper's date of birth.

Format: ISO-8601; example: YYYY-MM-DD

Required for the following risk checks:

shopperName (error)

A shopper's personal information including the firstName, infix, lastName, and gender.

Required for the following risk checks:

shopperEmail (error)

shopperIP

(error)
deliveryAddress (error)

The address where a shopper is going to receive goods/services. Providing the following detailed information street, houseNumberOrName, city, postalCode, stateOrProvince, country.

Required for the following risk checks:

billingAddress (error)

The address where a shopper is going to receive the bill. Providing the following detailed information street, houseNumberOrName, city, postalCode, stateOrProvince, country.

Required for the following risk checks:

deviceFingerprint (error)

Information from a shopper's device and uses the combined value to identify the device of the shopper.

Used in the following risk checks:

telephoneNumber

(error) A shopper's phone number (only in countries where it is legal to collect).

socialSecurityNumber

(error) A shopper's social security number (only in countries where it is legal to collect).
deliveryDate (error)

The expected date of delivery or fulfillment of the goods/services to the shopper.

Required for the following risk checks:

fraudOffset (error) An integer that is added to the final fraud score of all risk checks. The value can be either positive or negative.
merchantOrderReference (error) A reference that merchants can use to link multiple transactions to each other.
browserInfo (error) With the browser info data, we can determine if the device is mobile or not, which is used for device fingerprinting and other device logic.

Custom fields

Adyen allows you to send data in custom fields that can be used in Custom risk checksFor more information on the specific fields you can submit, see Risk data fields 

In order to request a field, contact Support Team and indicate:

  1. The name of the field (one word name).
  2. The data type of the field.

The options for data type are:

  • String

  • StringList

  • Number

  • NumberList

  • Date

  • DateList

After the field has been created, it is activated and appears in the Custom Risk Rule interface. AND/OR rules are then created.

You can then submit data to the additionaldata.riskdata.<customfieldname> field.

Submit data in a payment request

Below is an example of a payment request sent in by an e-commerce merchant who is providing a full set of data. These fields should be used within the additionalData field. For more information on submitting additionalData see the PaymentRequest.additionalData topic.

{
   "amount":{
      "value":1700,
      "currency":"EUR"
   },
   "card":{
      "number":"4111111111111111",
      "expiryMonth":"8",
      "expiryYear":"2018",
      "cvc":"737",
      "holderName":"Simon Hopper"
   },
   "reference":"LASPDAVIDDK2",
   "merchantAccount":"TestMerchant",
   "shopperReference":"test12345621217",
   "dateOfBirth":"1982-07-17",
   "shopperName":{
      "firstName":"Simon",
      "infix":"R.",
      "lastName":"Hopper",
      "gender":"MALE"
   },
   "shopperEmail":"s.hopper@test.com",
   "shopperIP":"61.294.12.12",
   "deliveryAddress":{
      "city":"San Francisco",
      "country":"USA",
      "houseNumberOrName":"85",
      "postalCode":"12345",
      "stateOrProvince":"California",
      "street":"123 Delivery Street"
   },
   "billingAddress":{
      "city":"San Francisco",
      "country":"USA",
      "houseNumberOrName":"85",
      "postalCode":"12345",
      "stateOrProvince":"California",
      "street":"123 Billing Street"
   },
   "telephoneNumber":"4154761000",
   "deliveryDate":"30062017",
   "additionalData":{
      "riskdata.deliveryMethod":"express",
      "riskdata.basket.item.productTitle":"Blue T Shirt",
      "riskdata.promotions.promotion.promotionName":"Big Sale promotion"
   }
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
   <soap:Body>
      <ns1:authorise xmlns:ns1="http://payment.services.adyen.com">
         <ns1:paymentRequest>
            <amount xmlns="http://payment.services.adyen.com">
               <value xmlns="http://common.services.adyen.com">1700</value>
               <currency xmlns="http://common.services.adyen.com">EUR</currency>
            </amount>
            <card xmlns="http://payment.services.adyen.com">
               <number>4111111111111111</number>
               <expiryMonth>08</expiryMonth>
               <expiryYear>2018</expiryYear>
               <cvc>737</cvc>
               <holderName>Simon Hopper</holderName>
            </card>
            <reference xmlns="http://payment.services.adyen.com">LASPDAVIDDK2</reference>
            <merchantAccount xmlns="http://payment.services.adyen.com">TestMerchant</merchantAccount>
            <shopperReference xmlns="http://payment.services.adyen.com">test12345621217</shopperReference>
            <dateOfBirth xmlns="http://payment.services.adyen.com">1982-07-17</dateOfBirth>
            <shopperName xmlns="http://payment.services.adyen.com">
               <firstName xmlns="http://common.services.adyen.com">Simon</firstName>
               <infix xmlns="http://common.services.adyen.com">R.</infix>
               <lastName xmlns="http://common.services.adyen.com">Hopper</lastName>
               <gender xmlns="http://common.services.adyen.com">MALE</gender>
            </shopperName>
            <shopperEmail xmlns="http://payment.services.adyen.com">s.hopper@test.com</shopperEmail>
            <shopperIP xmlns="http://payment.services.adyen.com">61.294.12.12</shopperIP>
			<deliveryAddress xmlns="http://payment.services.adyen.com">
 				<city xmlns="http://common.services.adyen.com">San Francisco</city>
              	<country xmlns="http://common.services.adyen.com">USA</country>
               	<houseNumberOrName xmlns="http://common.services.adyen.com">58</houseNumberOrName>
               	<postalCode xmlns="http://common.services.adyen.com">1234</postalCode>
               	<stateOrProvince xmlns="http://common.services.adyen.com">California</stateOrProvince>
               	<street xmlns="http://common.services.adyen.com">123 Delivery Street</street>
			</deliveryAddress>
			<billingAddress xmlns="http://payment.services.adyen.com">	
				<city xmlns="http://common.services.adyen.com">San Francisco</city>
              	<country xmlns="http://common.services.adyen.com">USA</country>
               	<houseNumberOrName xmlns="http://common.services.adyen.com">58</houseNumberOrName>
               	<postalCode xmlns="http://common.services.adyen.com">1234</postalCode>
               	<stateOrProvince xmlns="http://common.services.adyen.com">California</stateOrProvince>
               	<street xmlns="http://common.services.adyen.com">123 Billing Street</street>
			</billingAddress>
			<telephoneNumber xmlns="http://payment.services.adyen.com">4154761000</telephoneNumber>
			<deliveryDate xmlns="http://payment.services.adyen.com">30062017</deliveryDate>
            <additionalData xmlns="http://payment.services.adyen.com">
               <riskdata.deliveryMethod>express</riskdata.deliveryMethod>
			   <riskdata.basket.item.productTitle>Blue T Shirt</riskdata.basket.item.productTitle>
			   <riskdata.promotions.promotion.promotionName>Big Sale promotion</riskdata.promotions.promotion.promotionName>
            </additionalData>
         </ns1:paymentRequest>
      </ns1:authorise>
   </soap:Body>
</soap:Envelope>
merchantAccount=TestMerchant&amount.value=10000&amount.currency=EUR&card.expiryYear=2018&card.cvc=737&card.number=4111111111111111&card.holderName=Adyen+Test&card.expiryMonth=08&reference=Your+Reference+Here&shopperReference=Simon+Hopper&shopperEmail=s.hopper%40test.com&shopperIP=61.294.12.12&deliveryAddress.city=San+Francisco&deliveryAddress.country=USA&deliveryAddress.houseNumberOrName=58&deliveryAddress.postalCode=1234&deliveryAddress.stateOrProvince=California&deliveryAddress.street=123+Delivery Street&billingAddress.city=San+Francisco&billingAddress.country=USA&billingAddress.houseNumberOrName=58&billingAddress.postalCode=1234&billingAddress.stateOrProvince=California&billingAddress.street=123+Billing+Street&telephoneNumber=4154761000&deliveryDate=30062017&additionalData.riskdata.deliveryMethod=EXPRESS&additionalData.riskdata.basket.item.productTitle=Blue+T+Shirt&additionalData.riskdatapromotions.promotion.promotionName=Big+Sale+promotion