---
title: "Adyen Uplift requirements and recommendations"
description: "Learn more about required and recommended integration options, and which fields to include in your payment requests to make the best use of Adyen Uplift."
url: "https://docs.adyen.com/uplift/uplift-requirements"
source_url: "https://docs.adyen.com/uplift/uplift-requirements.md"
canonical: "https://docs.adyen.com/uplift/uplift-requirements"
last_modified: "2019-09-06T14:25:00+02:00"
language: "en"
---

# Adyen Uplift requirements and recommendations

Learn more about required and recommended integration options, and which fields to include in your payment requests to make the best use of Adyen Uplift.

[View source](/uplift/uplift-requirements.md)

To get the most benefit out of Adyen Uplift, we recommend that you collect as much information as possible about the shopper, their purchase, and their checkout process, and include this information in your payment request. Doing this ensures that Adyen Uplift will be able to make better recommendations because there are more properties connected to a payment.

You can use this page to see what is required or recommended depending on which online payments integration you have built, and which Adyen Uplift modules you intend to use.

## General requirements

Before you begin, take into account the following general Adyen Uplift requirements, recommendations and limitations.

| Requirement                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ----------------------------------------------- |   |
| **Integration type**                            | Make sure that you have built an [online payments integration](/online-payments/build-your-integration/) for Web. Recommended integrations:- Web Drop-in using the latest version (**v6**)
  * [Advanced flow](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=Drop-in) or [Sessions flow](/online-payments/build-your-integration/sessions-flow?platform=Web\&integration=Drop-in)
- Web Components using the latest version (**v6**)
  * [Advanced flow](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=Components) or [Sessions flow](/online-payments/build-your-integration/sessions-flow?platform=Web\&integration=Components)
- [Checkout API](https://docs.adyen.com/api-explorer/Checkout/latest/overview) version **v71** or laterOther supported integrations:- [Web API-only](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=API%20only) integration with [encrypted card data](/payment-methods/cards/custom-card-integration/) (**v71** or later)
- [Web API-only](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=API%20only) integration with [raw card data](/payment-methods/cards/raw-card-data) (**v71** or later)
 |
| **[Webhooks](/development-resources/webhooks)** | Make sure that you enable and accept webhooks.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **Limitations**                                 | If you use a Web API-only integration, and process raw card data, make sure that you have met the additional [PCI compliance requirements](/development-resources/pci-dss-compliance-guide/?tab=api_only_3_4#online-payments).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

## Module requirements

On top of the general requirements and recommendations, take into account the following requirements and recommendations for each Adyen Uplift module.

| Module       | Requirements and recommendations                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ------------ |   |
| Protect      | **Required**: use Adyen's [risk engine](/risk-management), Protect. **Recommended**:- Enable [Protect premium](/risk-management/configure-risk-settings) to configure and use the [fraud risk machine learning rule](/risk-management/configure-your-risk-profile/machine-learning-rules/), [case management](/risk-management/case-management/) and [custom rules](/risk-management/configure-your-risk-profile/custom-rules/).
- Enable [fraud data collection](/risk-management/fraud-data-collection/) on your checkout page and [collect additional data](/risk-management/fraud-data-collection/#collect-additional-data) outside of your checkout pages.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Tokenize     | **Required**: implement [tokenization](/online-payments/tokenization/) with Adyen.**Recommended**: enable Adyen optimization products.- Use network tokenization and enable [Network Token Optimization](/online-payments/network-tokenization/).
- Enable the [Real Time Account Updater](/online-payments/account-updater/real-time-account-updater/).
- Transition to using [token lifecycle webhooks](/online-payments/tokenization/managing-tokens/#webhooks) instead of the [RECURRING\_CONTRACT](/development-resources/webhooks/webhook-types/#non-default-event-codes) webhook.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Authenticate | **Required**: implement [3D Secure 2](/online-payments/3d-secure/), especially when you process online payments in the [European Economic Area](https://en.wikipedia.org/wiki/European_Economic_Area) (EEA) or the UK. This lets you:- Benefit from the Authentication Engine.
- Comply with authentication regulations that require strong customer authentication for online payments such as [PSD2 SCA](/online-payments/psd2-sca-compliance-and-implementation-guide/) in the EEA and the Payment Services Regulations 2017 in the UK.**Recommended**:- [Sessions flow](/online-payments/3d-secure#implement-3d-secure-2): 3D Secure 2 support is built-in, no additional configuration is required.

- [Advanced flow](/online-payments/3d-secure#implement-3d-secure-2):

  * For Web Drop-in or Web Components: implement [native](/online-payments/3d-secure/native-3ds2?platform=Web\&integration=Drop-in\&version=6.0.0%20and%20later) or [redirect](/online-payments/3d-secure/redirect-3ds2) 3D Secure 2.

  * * Native: gives you more control over the user experience, but to ensure the best performance regular upgrades and maintenance are required.
    * Redirect: for a quicker go live and less maintenance in the future.

    For Web API only:

    * Implement [native](/online-payments/3d-secure/native-3ds2?platform=Web\&integration=Components\&version=6.0.0%20and%20later) or [redirect](/online-payments/3d-secure/redirect-3ds2/web-component) 3D Secure 2. Follow the Components guides to integrate with the 3D Secure 2 or the Action Component.
    * Handle the `threeDS2` [additional action](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=API%20only\&version=71#additional-action).
    * Use the [3D Secure 2 API reference](/online-payments/3d-secure/api-reference/) to understand which fields are required and optional.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Optimize     | **Required**: support [co-badged cards](/online-payments/co-badged-cards-compliance/).- Web Drop-in or Web Components: minimum **v6.16.0**, recommended **v6.18.1**
- Web API only: when you process [raw card details](/payment-methods/cards/raw-card-data/#co-badged), use the [/cardDetails](https://docs.adyen.com/api-explorer/Checkout/latest/post/cardDetails) endpoint.**Recommended**: enable Adyen optimization products and payment methods.- Enable [Auto Rescue](/online-payments/auto-rescue/cards/) for card payments.
- Add additional [payment methods](/payment-methods/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Personalize  | **Required**:- Web Drop-in using the latest version (**v6**)

  * [Sessions flow](/online-payments/build-your-integration/sessions-flow?platform=Web\&integration=Drop-in) (**Recommended integration**): Provide shopper data when you [create the session](/online-payments/build-your-integration/sessions-flow?platform=Web\&integration=Drop-in%2F#create-payment-session). At minimum, provide `shopperEmail`.

  * [Advanced flow](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=Drop-in):

    * Provide shopper data in the [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods) and [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) request. At minimum, provide `shopperEmail`.
    * Use a [shopper conversion identifier](/online-payments/checkout-settings#checkout-shopper-conversion-id) and include it in the [shopperConversionId](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperConversionId) field to link a shopper to a single checkout session.

- Web Components using the latest version (**v6**)

  * [Sessions flow](/online-payments/build-your-integration/sessions-flow?platform=Web\&integration=Components):

    * Provide shopper data when you [create the session](/online-payments/build-your-integration/sessions-flow/?platform=Web\&integration=Components\&utm_source=online-payments-integration%2F#create-payment-session). At minimum, provide `shopperEmail`.
    * Make sure that the order of payment methods displayed in your checkout form is the same as the order that is returned in the payment methods response of the `AdyenCheckout` [instance](/online-payments/build-your-integration/sessions-flow?platform=Web\&integration=Components#configure).

  * [Advanced flow](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=Components):

    * Provide shopper data in the [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods) and [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) request. At minimum, provide `shopperEmail`.
    * Make sure that the order of payment methods displayed in your checkout form is the same as the order that is returned in the [payment methods response](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=Components#get-available-payment-methods).
    * Use a [shopper conversion identifier](/online-payments/checkout-settings#checkout-shopper-conversion-id) and include it in the [shopperConversionId](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperConversionId) field to link a shopper to a single checkout session.

- Web API only
  * [Advanced flow](/online-payments/build-your-integration/advanced-flow?platform=Web\&integration=API%20only): same requirements as the Advanced flow for Web components. |

## Data point requirements

Some fields such as `amount` and `reference` are required for each payment request. Other fields such as `shopperIP`, `shopperReference`, and `shopperEmail` are not required for the payment request to work, but recommended to include to ensure your integration supports Adyen Uplift, to improve recommendations, or to help you increase conversion rates.

The following data points are recommended or required to include in your payment request, for all or for specific Adyen Uplift modules. In the details you can find information about why the data point is recommended to include. This can be, for example, to support a certain integration type, to unlock a scenario, or to be able to use a specific module or feature.

| Field                                  | Recommendation               | Details                                                                                                                                                                                                                                                                                                                                                                                                                                                          | API reference                                                                                                                                                                                                                                                       |
| -------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount`                               | All modules                  | **Required** in all payment requests.                                                                                                                                                                                                                                                                                                                                                                                                                            | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-amount) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-amount)                                                                         |
| `merchantAccount`                      | All modules                  | **Required** in all payment requests.                                                                                                                                                                                                                                                                                                                                                                                                                            | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-merchantAccount) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-merchantAccount)                                                       |
| `reference`                            | All modules                  | **Required** in all payment requests.                                                                                                                                                                                                                                                                                                                                                                                                                            | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-reference) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-reference)                                                                   |
| `returnUrl`                            | All modules                  | **Required** in all payment requests.                                                                                                                                                                                                                                                                                                                                                                                                                            | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-returnUrl) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-returnUrl)                                                                   |
| `applicationInfo`                      | All modules                  | **Must be included** if you are a [partner building an integration](/partners), for example a plugin.                                                                                                                                                                                                                                                                                                                                                            | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-applicationInfo) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-applicationInfo)                                                       |
| `browserInfo`                          | All modules                  | **Must be included** for the Advanced flow for Web Drop-in and Web Components.                                                                                                                                                                                                                                                                                                                                                                                   | [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-browserInfo)                                                                                                                                                                  |
| `channel`                              | All modules                  | **Must be included** with the value **Web** to avoid the system from having to infer it.                                                                                                                                                                                                                                                                                                                                                                         | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-channel) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-channel)                                                                       |
| `checkoutAttemptId`                    | All modules                  | **Must be included** for the Advanced flow for Web Drop-in and Web Components.                                                                                                                                                                                                                                                                                                                                                                                   | [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-checkoutAttemptId)                                                                                                                                                            |
| `paymentMethod`                        | All modules                  | **Must be included** for the Advanced flow for Web Drop-in and Web Components.                                                                                                                                                                                                                                                                                                                                                                                   | [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-paymentMethod)                                                                                                                                                                |
| `riskData.clientData`                  | Protect module               | **Must be included** for Web API-only integrations to send the [data collected](/risk-management/fraud-data-collection#data-collection-add-sdk) by the SDK in the payment request. Automatically collected and included when you use Web Drop-in or Web Components.                                                                                                                                                                                              | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-riskData) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-riskData)                                                                     |
| `recurringProcessingModel`             | Tokenize module              | **Must be included** for tokenization. Used to define the recurring payment type that will be used for future [recurring payments](/online-payments/tokenization/#recurring-payment-types).                                                                                                                                                                                                                                                                      | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-recurringProcessingModel) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-recurringProcessingModel)                                     |
| `shopperConversionId`                  | Personalize module           | **Must be included** for the Advanced flow for Web Drop-in, Web Components and Web API only. Used to [uniquely identify a shopper's checkout session](/online-payments/checkout-settings#checkout-shopper-conversion-id) and associate [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods) and [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) requests with the same shopper transaction. | [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#request-shopperConversionId) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperConversionId)                                   |
| `shopperEmail`                         | All modules                  | **Must be included** to improve shopper recognition and optimizations such as fraud detection and 3D Secure 2 authentication.                                                                                                                                                                                                                                                                                                                                    | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-shopperEmail) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperEmail)                                                             |
| `shopperInteraction`                   | All modules                  | **Must be included** for tokenization. Recommended for all modules.                                                                                                                                                                                                                                                                                                                                                                                              | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-shopperInteraction) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperInteraction)                                                 |
| `shopperIP`                            | All modules                  | **Must be included** to improve shopper recognition and optimizations. Automatically collected and included when you use the Sessions flow.                                                                                                                                                                                                                                                                                                                      | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#responses-201-shopperIP) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperIP)                                                             |
| `shopperReference`                     | All modules                  | **Must be included** for tokenization. Recommended for all modules.                                                                                                                                                                                                                                                                                                                                                                                              | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-shopperReference) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperReference)                                                     |
| `storePaymentMethod`                   | Tokenize module              | **Must be included** for tokenization. Used to create a token to store payment method details for future [recurring payments](/online-payments/tokenization/#recurring-payment-types).                                                                                                                                                                                                                                                                           | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-storePaymentMethod) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-storePaymentMethod)                                                 |
| `accountInfo`                          | Authenticate module          | Used to send shopper account information for [3D Secure 2](/online-payments/3d-secure/api-reference/#accountinfo) to increase the chances of achieving the [frictionless flow](/online-payments/3d-secure#frictionless-flow).                                                                                                                                                                                                                                    | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-accountInfo) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-accountInfo)                                                               |
| `additionalData.` `enhancedSchemeData` | Optimize module              | Used to send in level 2 or level 3 [Enhanced Scheme Data](/payment-methods/cards/enhanced-scheme-data/l2-l3/) (ESD). Only available under conditions for US domestic payments, and limited to specific card schemes.                                                                                                                                                                                                                                             | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataLevel23) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-additionalData-AdditionalDataLevel23)             |
| `additionalData.` `AdditionalDataRisk` | Protect module               | Used to enable specific risk management scenarios. For example, to specify values for custom risk fields that you have created, for promotions, or if you want to skip risk.                                                                                                                                                                                                                                                                                     | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRisk-riskdata-skipRisk) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-additionalData-AdditionalDataRisk) |
| `billingAddress`                       | All modules                  | Used to improve shopper recognition and optimizations such as address verification ([AVS](/risk-management/avs-checks/)).                                                                                                                                                                                                                                                                                                                                        | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-billingAddress) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-billingAddress)                                                         |
| `countryCode`                          | All modules                  | Used to improve optimizations and recommendations.                                                                                                                                                                                                                                                                                                                                                                                                               | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-countryCode) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-countryCode)                                                               |
| `dateOfBirth`                          | All modules                  | Used to improve shopper recognition and optimizations.                                                                                                                                                                                                                                                                                                                                                                                                           | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-dateOfBirth) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-dateOfBirth)                                                               |
| `lineItems`                            | Protect and Optimize modules | Used to include details about purchased items in the payment request.                                                                                                                                                                                                                                                                                                                                                                                            | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-lineItems) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-lineItems)                                                                   |
| `merchantOrderReference`               | All modules                  | Used to enable the linking of multiple payment requests to improve optimizations. For example, this field helps track authorization rates and lets you benefit from being able to link payment requests when authorization retries take place.                                                                                                                                                                                                                   | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-merchantOrderReference) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-merchantOrderReference)                                         |
| `paymentMethod.holderName`             | All modules                  | Used to improve shopper recognition and optimizations. Automatically collected and included when you use the Sessions flow.                                                                                                                                                                                                                                                                                                                                      | [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-paymentMethod-CardDetails-holderName)                                                                                                                                         |
| `shopperLocale`                        | All modules                  | Used to improve optimizations and recommendations.                                                                                                                                                                                                                                                                                                                                                                                                               | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-shopperLocale) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-shopperLocale)                                                           |
| `telephoneNumber`                      | All modules                  | Used to improve shopper recognition and optimizations.                                                                                                                                                                                                                                                                                                                                                                                                           | [/sessions](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-telephoneNumber) [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-telephoneNumber)                                                       |

## See also

* [Adyen Uplift landing page](/uplift)
* [Data collection to detect fraud](/risk-management/fraud-data-collection)
* [Data quality and risk field reference](/risk-management/configure-your-risk-profile/risk-field-reference)
* [Analytics and data tracking](/online-payments/analytics-and-data-tracking/)
