Native 3D Secure 2 authentication

This page explains how to implement native 3D Secure 2 authentication with your existing Web Drop-in integration.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

How it works

When making a card payment with native 3D Secure 2 authentication:

1. Show the available cards in your payment form.
2. Configure Drop-in to collect the cardholder name.
3. Provide additional parameters when making a payment request.
4. Submit authentication result if you receive an action object in response to your /payments or /payments/details request.
5. Handle the redirect result if the payment was routed to the 3D Secure 2 redirect flow.

Show the available cards in your payment form

Drop-in uses the combination of countryCode and amount.currency from your /paymentMethods request to show the available cards to your shopper.

When the shopper is entering their card details, Drop-in tries to recognize the card brand. When successful, Drop-in renders the brand icon and the corresponding input field for the card security code (CVC, CVV, or CID).

Collect additional parameters in your payment form

For higher authentication rates, we strongly recommend that you collect the cardholder name, billing address, and email address for payments with 3D Secure authentication.

Configure cards with Drop-in

When creating a configuration object for Drop-in, add optional configuration for cards in your paymentMethodsConfiguration object.

You can customize your shopper's experience further with optional configuration parameters and specific events.

const dropin = new Dropin(checkout, {
  paymentMethodsConfiguration: {
    card: {
      hasHolderName: true,
      holderNameRequired: true,
      billingAddressRequired: true,
      challengeWindowSize: "05"
    }
  }
}).mount("#dropin-container");

Handle Drop-in errors

When an error occurs, the onError event returns an object which contains details about the error.

For errors that happen during the 3D Secure 2 authentication, you do not need to stop the payment flow because the shopper can continue.

Collect shopper email in your payment form

We also recommend that you collect the shopper email in advance in your payment form. Deliver this parameter to your backend when making a payment, because it is required by the card schemes.

Make a payment

When the shopper selects to pay, Drop-in calls the onSubmit event, which contains a state.data.

1. Pass the state.data to your server.

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

   Parameter name	Required	Description
   paymentMethod		The state.data.paymentMethod object from the onSubmit event.
   paymentMethod.holderName	Required for Visa	The cardholder's name.
   browserInfo		The state.data.browserInfo object from the onSubmit event.
   authenticationData. nativeThreeDS		Set to preferred. Indicates that your payment page can handle 3D Secure 2 transactions natively.(authenticationData object is available from Checkout API v69)
   channel		Set to Web.
   origin		The origin URL of the page where you are rendering the Drop-in. This can be a maximum of 80 characters and should not include subdirectories and a trailing slash. For example, if you are rendering the Drop-in on https://your-company.com/checkout/payment, specify: https://your-company.com. To get the origin: Open the browser console and call window.location.origin.
   returnUrl		In case of 3D Secure 2 redirect flow, this is the URL where the shopper is redirected back to after completing 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.
   billingAddress		The state.data.billingAddress object from the onSubmit event.
   shopperEmail	Required for Visa	The cardholder's email address. shopperEmail or a phone number is required for Visa.
   shopperIP	Required for Visa	The shopper's IP address.
   threeDS2requestData.homePhone threeDS2RequestData.workPhone threeDS2RequestData.mobilePhone	Required for Visa	A phone number for the shopper, include one of these fields. shopperEmail or a phone number is required for Visa.

curl https://checkout-test.adyen.com/checkout/v69/payments \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'content-type: application/json' \
-d '{
   "amount":{
      "currency":"",
      "value":1000
   },
   "reference":"YOUR_ORDER_NUMBER",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "paymentMethodstate.data.paymentMethod from onSubmit":{
      "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"
   },
   "authenticationData": {
      "threeDSRequestData": {
    	"nativeThreeDS": "preferred"
      }
   },
   "browserInfostate.data.browserInfo from onSubmit":{
      "userAgent":"",
      "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
   },
   "billingAddressstate.data.billingAddress from onSubmit": {
       "street": "Infinite Loop",
       "houseNumberOrName": "1",
       "postalCode": "1011DJ",
       "city": "Amsterdam",
       "country": "NL"
  },
   "shopperEmail":"s.hopper@example.com",
   "shopperIP":"192.0.2.1",
   "channel":"web",
   "origin":"https://your-company.com",
   "returnUrl":"",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
}'

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

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

{
    "action":{
        "type":"threeDS2",
        "subtype": "fingerprint",
        "paymentData":"Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...",
        "paymentMethodType":"scheme",
        "authorisationToken" : "Ab02b4c0!BQABAgAvrX03p...",
        "token":"eyJ0aHJlZURTTWV0aG9kTm90aWZpY..."
    },
    "resultCode":"IdentifyShopper",
    ...
}

Submit the authentication result

Drop-in handles the action after it is returned within the onSubmit event and performs the required authentication flow. If the issuer requires shopper interaction, Drop-in presents the challenge screen.

const checkout = await AdyenCheckout({
  onSubmit: async (state, component, actions) => {
    // Make the /payments request and pass the action and resultCode back to Drop-in
    const { action, resultCode } = await makePayment(state.data);
    actions.resolve({ action, resultCode });
  },
  // ...Your other AdyenCheckout configurations.
  });

When the shopper completes the challenge, Drop-in calls the onAdditionalDetails event.

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

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

   • details: The state.data.details from the onAdditionalDetails event.
   /payments/details request

   Expand view

   Copy link to code block

   Copy code

   Copy code

   curl https://checkout-test.adyen.com/checkout/v70/payments/details \
   -H 'x-api-key: ADYEN_API_KEY' \
   -H 'content-type: application/json' \
   -d '{
       ...
       "details": {
         "threeDSResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
     }
   }'

   The /payments/details response has a resultCode. You will need it to present the payment result.

3. Pass the resultCode you received in the /payments/details response to the actions.resolve() object. Depending on the result code, the onPaymentCompleted or onPaymentFailed event is triggered to complete the payment flow.

   Pass the result code to Drop-in with onAdditionalDetails

   Expand view

   Copy link to code block

   Copy code

   Copy code

   const checkout = await AdyenCheckout({
     onSubmit: async (state, component, actions) => {...}
     onAdditionalDetails: async (state, component, actions) => {
       // Make the /payments/details call and pass the resultCode back to the Drop-in.
       const { action, resultCode } = await makePaymentDetails(state.data);
       actions.resolve({ resultCode });
      },
     onPaymentCompleted(result, component) {
      // Handle the successful payment flow.
     },
     onPaymentFailed(result, component) {
       // Handle the failed payment flow.
     },
     // ... Your other AdyenCheckout configurations.
   });

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 webhook.

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

Testing

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

See also