Online-payment icon

3D Secure 2 Component integration

Add native 3D Secure 2 authentication to your integration.

  Postman collection

Implementation examples


The Components integration handles frictionless and challenge 3D Secure authentication flows, including the data exchange between your front end and the issuer's Access Control Server (ACS).

Follow the instructions on this page if your integration uses the /payments or /payments/details endpoint, and Checkout API 49 or later.

If your integration uses only the /sessions endpoint, you don't need additional configuration for 3D Secure. If you're using Checkout API 46 or earlier, follow instructions in the 3D Secure 2 integration guide for v46 or earlier.

To handle native 3D Secure 2 authentication:

  1. Get additional shopper details in your payment form.
  2. Make a payment request, including additional shopper details.
  3. Handle the 3D Secure 2 action to perform the authentication flow.
  4. Submit the authentication result.
  5. Show the payment result.

Before you begin

This page assumes that you've already either:

A strict CSP for your website can prevent native 3D Secure 2 challenges from being loaded on your website. You can use the redirect flow if you don't want to adjust your CSP.

If you are using 3D Secure for PSD2 compliance, read our comprehensive PSD2 SCA guide.

Step 1: Get additional shopper details in your payment form

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

Get the shopper's email outside of the Card Component because it doesn't have a configuration to include shopper email in the payment form.

To get the cardholder name and billing address in your payment form, include the following when creating an instance of the Card Component:

  • hasHolderNametrue. This shows the input field for the cardholder name.
  • holderNameRequired: true. This makes the cardholder name a required field.
  • billingAddressRequired: true. This shows the billing address input fields.

Do not use placeholder data for these fields in your live environment.

     const card = checkout.create("card", {
         hasHolderName: true,
         holderNameRequired: true,
         billingAddressRequired: true

Step 2: Make a payment

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

Parameter name Required Description
paymentMethod -white_check_mark- The object from the onChange event.
paymentMethod.holderName Required for Visa The cardholder's name. For higher authentication rates, we strongly recommend including paymentMethod.holderName for all schemes.
browserInfo -white_check_mark- The object from the onChange event.
authenticationData.threeDSRequestData.nativeThreeDS -white_check_mark- Set to preferred. Indicates that your payment page can handle 3D Secure 2 transactions natively.
channel -white_check_mark- Set to Web.
origin -white_check_mark- The origin URL of the page where you are rendering the Component. This can be a maximum of 80 characters and should not include subdirectories and a trailing slash. For example, if you are rendering the Component on, specify:

To get the origin:
  • Open the browser console and call window.location.origin.
returnUrl -white_check_mark- In case of a 3D Secure 2 redirect flow, this is the URL where the shopper will be redirected back to after completing authentication. The URL should include the protocol: http:// or https://. For example, You can also include your own additional query parameters, for example, shopper ID or order reference number.
billingAddress The 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.workPhone or
Required for Visa A phone number for the shopper, include one of these fields. shopperEmail or a phone number is required for Visa.

Your next steps depend on if the /payments response contains an action object. Choose your API version:

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 show the payment result to your shopper.
threeDS2 The payment qualifies for 3D Secure 2, and will go through the authentication flow. 1. Pass the action object to your front end.
2. Use the Component to perform the authentication flow.
3. Submit the authentication result.
redirect The payment is routed to the 3D Secure 2 redirect flow.
1. Pass the action object to your front end.
2. Use handleAction to handle the redirect.
3. Confirm the redirect result.

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

Step 3: Handle the 3D Secure 2 action

If your integration uses Card Component v3.6.0 or later to collect the shopper's card details, also use it to handle the 3D Secure 2 action on the same page.

If you built your own UI for collecting the shopper's card details or want to render 3D Secure authentication on a different page than the payment, create a new 3D Secure 2 Component.

To handle the action:

  1. Call handleAction, passing the action object from the /payments response.
  2. The Card Component calls onAdditionalDetails to handle the action.
  3. The onAdditionalDetails event returns authentication data in that you must submit.

Handle Component errors

When an error occurs, Component calls the onError handler.

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

Step 4: Submit the authentication result

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

  • details: The from the onAdditionalDetails event.

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

Step 5: Show 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:

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 if they want to continue with the order, or ask them to 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 authentication scenarios.

See also