Search

Are you looking for test card numbers?

Would you like to contact support?

Online-payment icon

3D Secure 2 Component

Add native 3D Secure 2 authentication to your integration.

Our 3D Secure 2 Component handles the 3D Secure 2 device fingerprinting and challenge flows, including the data exchange between your front end and the issuer's Access Control Server (ACS).

When adding native 3D Secure 2 authentication to your integration:

  1. Collect the card holder name in your payment form.
  2. Provide additional parameters when making a payment request.
  3. Use the 3D Secure Component to perform the authentication flow. In case of a 3D Secure 1 fallback, you also need to handle the redirect.

This page describes the integration steps for v3.1.0 or later of Web Components. If you are using an earlier version, refer to an earlier version of this integration guide.

Before you begin

Before starting your integration, make sure that you have integrated our Card Component, or built you own UI for collecting shopper's card details.

Collect card holder name in your payment form

For higher authentication rates, we strongly recommend that you collect the card holder name for payments with 3D Secure authentication.

If you are using our Card Component, include the following when creating an instance of the Card Component:

  • hasHolderNametrue. This shows the input field for the card holder name.
  • holderNameRequired: true. This makes the card holder name a required field.
     const card = checkout.create("card", {
         hasHolderName: true,
         holderNameRequired: true
     }).mount("#card-container");

Make a payment

From your server, make a /payments request, specifying:

  • paymentMethod: If using the Card Component, pass the state.data.paymentMethod from the onChange event. If submitting raw card data, refer to Raw card data for the fields that you need to pass.

    For higher authentication rates, we strongly recommend that you include paymentMethod.holderName.

  • browserInfo: The state.data.browserInfo from the onChange event.
  • additionalData.allow3DS2true.
  • channel: Web
  • shopperIP: The shopper's IP address.
  • origin: The origin URL of the page where you are rendering the card payment form. This should not include subdirectories and a trailing slash. For example, if you are rendering the component on https://your-company.com/checkout/payment, specify here: https://your-company.com.

    You can get the origin by opening the browser console and calling window.location.origin. The origin can be a maximum of 80 characters.

  • returnURL: In case of a 3D Secure 1 fallback, this is the URL where the shopper will be redirected back to after completing 3D Secure 1 authentication. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

To increase the likelihood of achieving a frictionless flow and higher authorisation rates, we also recommend that you send additional parameters in this list.

curl https://checkout-test.adyen.com/v51/payments \
-H "X-API-key: [Your API Key here]" \
-H "Content-Type: application/json" \
-d '{
  "amount":{
    "currency":"EUR",
    "value":1000
  },
  "reference":"YOUR_ORDER_NUMBER",
  {hint:state.data.paymentMethod from onChange or onSubmit}paymentMethod{/hint}: {
    type: "scheme",
    encryptedCardNumber: "adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
    encryptedExpiryMonth: "adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
    encryptedExpiryYear: "adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
    encryptedSecurityCode: "adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+.."
    holderName: "S. Hopper"
  },
  "additionalData" : {
     "allow3DS2":true
  },
  "{hint:state.data.browserInfo from onChange or onSubmit}browserInfo{/hint}"::{
    "userAgent":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36",
    "acceptHeader":"text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8",
    "language":"nl-NL",
    "colorDepth":24,
    "screenHeight":723,
    "screenWidth":1536,
    "timeZoneOffset":0,
    "javaEnabled": true
  },
  "shopperIP": "192.0.2.1",
  "channel" : "web",
  "origin" : "https://your-company.com",
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
}'

Your next steps depend on whether the /payments response contains an action object, and on the action.type:

action.type Description Next steps
No action object The transaction was either exempted or out-of-scope for 3D Secure 2 authentication. Use the resultCode to present the payment result to your shopper.
threeDS2Fingerprint The payment qualifies for 3D Secure 2, and will go through either the frictionless or the challenge flow. 1. Pass the action object to your front end.
2. Use the 3D Secure 2 Component to perform the authentication flow.
threeDS2Challenge The payment qualifies for 3D Secure 2, and the issuer is initiating a challenge flow. 1. Pass the action object to your front end.
2. Use the 3D Secure 2 Component to perform the authentication flow.
redirect We will initiate a 3D Secure 1 fallback, because the issuer does not support 3D Secure 2.
1. Store action.paymentData on your server.
2. Pass the action object to your front end.
3. Use createFromAction to handle the redirect.

The following example shows a /payments response with action.type: threeDS2Fingerprint:

{
  "resultCode":"IdentifyShopper",
  "action":{
    "paymentData":"Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...",
    "paymentMethodType":"scheme",
    "token":"eyJ0aHJlZURTTWV0aG9kTm90aWZpY...",
    "type":"threeDS2Fingerprint"
  },
  "authentication":{
    "threeds2.fingerprintToken":"eyJ0aHJlZURTTWV0aG9kTm90aWZpY..."
  },
  ...
}

Use the 3D Secure 2 Component

If you received action.type: threeDS2Fingerprint, or action.type: threeDS2Challenge, use the 3D Secure 2 Component to perform the required authentication flow:

  1. Include the following script in the <body> above any other JavaScript in your checkout page: 

    <script src="https://checkoutshopper-live.adyen.com/checkoutshopper/sdk/3.3.0/adyen.js"></script>
  2. Use the following CSS file:

    <link rel="stylesheet" href="https://checkoutshopper-live.adyen.com/checkoutshopper/sdk/3.3.0/adyen.css"/>
  3. Create an instance of AdyenCheckout, specifying the following parameters:

    Parameter Description
    locale The shopper's locale. This is used to set the language rendered in the Components. For a list of supported locales, see Localization.
    originKey The origin key of your website. To find out how to generate one, see How to get an origin key.
    environment When you're ready to accept live payments, change the value to one of our live environments
    onAdditionalDetails Specify a function that the Component calls after performing the required authentication flow.
    function handleOnAdditionalDetails(state, component) {
         state.data // Provides the data that you need to pass in the `/payments/details` call.
         component // Provides the active component instance that called this event.
     }
    
     const configuration = {
         locale: "en_US",
         environment: "test",
         originKey: "YOUR_ORIGIN_KEY",
         onAdditionalDetails: handleOnAdditionalDetails
     };
    
     const checkout = new AdyenCheckout(configuration);
  4. Call createFromAction and pass the action object. This will return a new Component that you need to mount:

    checkout.createFromAction(action).mount('#my-container');

    The new Component performs the required authentication flow, and calls the onAdditionalDetails event.

  5. Get the state.data from the onAdditionalDetails event, and pass it your server.

  6. From your server, make a POST /payments/details request, specifying:

    • details: The state.data.details from the onAdditionalDetails event.
    • paymentData: The state.data.paymentData from the onAdditionalDetails event.

curl https://checkout-test.adyen.com/v51/payments/details \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
      "{hint:state.data.details from onAdditionalDetails}details{/hint}":{
         "threeds2.fingerprint":"eyJ0aHJlZURTQ29tcEluZCI6IlkifQ=="
      },
      "{hint:state.data.paymentData from onAdditionalDetails}paymentData{/hint}":"Ab02b4c0!BQABAgAKspbjN8+5..."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.env = :test
adyen.api_key = "YOUR_X-API-KEY"

request = COMPONENT_DATA
# Data object passed from onAdditionalDetails event of the front end, parsed from JSON to a Hash.

response = adyen.checkout.payments.details(request)

# Check if further action is needed.
if response.body.has_key(:action)
   # Pass the action object to your frontend
   puts response.body[:action]
else
   # No further action needed, pass the resultCode to your frontend
   puts response.body[:resultCode]
end
// Set your X-API-KEY with the API key from the Customer Area.
String apiKey = "YOUR_X-API-KEY";

String paymentData = "Ab02b4c0!BQABAgAKspbjN8+5...";
String fingerPrint = "eyJ0aHJlZURTQ29tcEluZCI6IlkifQ==";

Client client = new Client(apiKey,Environment.TEST);
Checkout checkout = new Checkout(client);
PaymentDetailsRequest paymentDetailsRequest = new PaymentDetailsRequest();
paymentDetailsRequest.setFingerPrint();
PaymentsResponse paymentsResponse = checkout.paymentDetails(PaymentDetailsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = COMPONENT_DATA;
// Data object passed from onAdditionalDetails event of the front end parsed from JSON to an array

$result = $service->paymentDetails($params);

// Check if further action is needed
if (array_key_exists("action", $result){
   // Pass the action object to your frontend.
   // $result["action"]
}
else {
   // No further action needed, pass the resultCode to your front end
   // $result['resultCode']
}
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

request = COMPONENT_DATA
# Data object passed from onAdditionalDetails event of the front end, parsed from JSON to a dictionary

result = adyen.checkout.payments_details(request)

# Check if further action is needed.
if 'action' in result.message:
   # Pass the action object to your front end
   # result.message['action']
else:
   # No further action needed, pass the resultCode to your front end
   # result.message['resultCode']
// Set your X-API-KEY with the API key from the Customer Area.
string apiKey = "YOUR_X-API-KEY";

string fingerPrint = "eyJ0aHJlZURTQ29tcEluZCI6IlkifQ==";
string paymentData = "Ab02b4c0!BQABAgAKspbjN8+5...";

var client = new Client (apiKey, Environment.Test);
var checkout = new Checkout(client);

var details = new Dictionary<string, string>
{
  { "threeds2.fingerprint": fingerPrint }
};
var paymentsDetailsRequest = new Model.Checkout.PaymentsDetailsRequest(Details: details, PaymentData: paymentData);
var paymentResponse = checkout.PaymentDetails(paymentsDetailsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.paymentsDetails({
    details: {COMPONENT_DATA}  // Data object passed from onAdditionalDetails event of the front end
}).then(res => res);

Your next steps depend on whether the /payments/details response contains an action object:

action.type Description Next steps
No action object The 3D Secure 2 authentication process has been completed. Use the resultCode to present the payment result to your shopper.
threeDS2Challenge The issuer requires shopper interaction, and is initiating a challenge flow. 1. Pass the action object to your front end.
2. Go back to step 1 to perform the required authentication flow.

Present the payment result

Use the resultCode from the /payments or /payments/details response to present the payment result to your shopper. You will also receive the outcome of the payment asynchronously in a notification webhook.

For card payments, you can receive the following resultCode values:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
If you are using manual capture, you also need to capture the payment.
Cancelled The shopper cancelled the payment. Ask the shopper whether they want to continue with the order, or request that they select a different payment method.
Error There was an error when the payment was being processed. For more information, check the refusalReason field. Inform the shopper that there was an error processing their payment.
Refused The payment was refused. For more information, check the refusalReason field. Ask the shopper to try the payment again using a different payment method.

Test and go live

Use our test card numbers to test how your integration handles different 3D Secure 2 authentication scenarios.

See also