No momento, esta página não está disponível em português
Uplift icon

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.

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 for Web.

Recommended integrations: Other supported integrations:
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.

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 or transition to the latest risk engine, Protect.

Recommended:
Tokenize

Required: implement tokenization with Adyen.

Recommended: enable Adyen optimization products.
Authenticate

Required: implement 3D Secure 2, especially when you process online payments in the European Economic Area (EEA). This lets you:

  • Benefit from the Authentication Engine.
  • Comply with authentication regulations for online payments such as PSD2 SCA that requires strong customer authentication to make online payments in the EEA.

Recommended:

  • Sessions flow: 3D Secure 2 support is built-in, no additional configuration is required.
  • Advanced flow:
    • For Web Drop-in or Web Components: implement native or redirect 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:
Optimize

Required: support co-badged cards.

  • Web Drop-in or Web Components: minimum v6.16.0, recommended v6.18.1
  • Web API only: when you process raw card details, use the /cardDetails endpoint.

Recommended: enable Adyen optimization products and payment methods.

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
/payments
merchantAccount All modules Required in all payment requests. /sessions
/payments
reference All modules Required in all payment requests. /sessions
/payments
returnUrl All modules Required in all payment requests. /sessions
/payments
applicationInfo All modules Must be included if you are a partner building an integration, for example a plugin. /sessions
/payments
browserInfo All modules Must be included for the Advanced flow for Web Drop-in and Web Components. /payments
channel All modules Must be included with the value Web to avoid the system from having to infer it. /sessions
/payments
checkoutAttemptId All modules Must be included for the Advanced flow for Web Drop-in and Web Components. /payments
paymentMethod All modules Must be included for the Advanced flow for Web Drop-in and Web Components. /payments
riskData.clientData Protect module Must be included for Web API-only integrations to send the data collected by the SDK in the payment request.

Automatically collected and included when you use Web Drop-in or Web Components.		 /sessions
/payments
recurringProcessingModel Tokenize module Must be included for tokenization.

Used to define the recurring payment type that will be used for future recurring payments.		 /sessions
/payments
shopperConversionId All modules Must be included for the Advanced flow for Web Drop-in and Web Components. /payments
shopperEmail All modules Must be included to improve shopper recognition and optimizations such as fraud detection and 3D Secure 2 authentication. /sessions
/payments
shopperInteraction All modules Must be included for tokenization.
Recommended for all modules.		 /sessions
/payments
shopperIP All modules Must be included to improve shopper recognition and optimizations.

Automatically collected and included when you use the Sessions flow.		 /sessions
/payments
shopperReference All modules Must be included for tokenization.
Recommended for all modules.		 /sessions
/payments
storePaymentMethod Tokenize module Must be included for tokenization.

Used to create a token to store payment method details for future recurring payments.		 /sessions
/payments
accountInfo Authenticate module Used to send shopper account information for 3D Secure 2 to increase the chances of achieving the frictionless flow. /sessions
/payments
additionalData.
enhancedSchemeData		 Optimize module Used to send in level 2 or level 3 Enhanced Scheme Data (ESD).

Only available under conditions for US domestic payments, and limited to specific card schemes.		 /sessions
/payments
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
/payments
billingAddress All modules Used to improve shopper recognition and optimizations such as address verification (AVS). /sessions
/payments
countryCode All modules Used to improve optimizations and recommendations. /sessions
/payments
dateOfBirth All modules Used to improve shopper recognition and optimizations. /sessions
/payments
lineItems Protect and Optimize modules Used to include details about purchased items in the payment request. /sessions
/payments
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
/payments
paymentMethod.holderName All modules Used to improve shopper recognition and optimizations.

Automatically collected and included when you use the Sessions flow.		 /payments
shopperLocale All modules Used to improve optimizations and recommendations. /sessions
/payments
telephoneNumber All modules Used to improve shopper recognition and optimizations. /sessions
/payments

See also