Online-payment icon

Redirect 3DS Drop-in integration

Support cards with 3D Secure authentication through a redirect on your website.

  Postman collection

Implementation examples


Our Web Drop-in renders the available cards in your payment form, and securely collects any sensitive card information, so it doesn't touch your server. Drop-in also redirects the shopper to perform the 3D Secure 2 authentication.

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.

When adding card payments with redirect 3D Secure authentication to your integration, you additionally need to:

  1. Configure Drop-in to collect the card holder name.
  2. Provide the required 3D Secure parameters when making a payment request.
  3. Handle the redirect result after the shopper returns to your website.

Before you begin

This page explains how to add cards with redirect 3D Secure authentication to an existing Web Drop-in integration. The Web Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payments form.
  2. Add the cards that you want to accept in your test Customer Area.
  3. If you are using 3D Secure for PSD2 compliance, read our comprehensive PSD2 SCA guide.

Show the available cards in your payment form

For information about the supported countries/regions and currencies for each card, refer to Payment methods.

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 card holder name, billing address, and email address for payments with 3D Secure authentication.

Configure Drop-in

When creating an instance of Drop-in, you can optionally specify the following fields:

Field Description Default
hasHolderName Set to true to show the input field for the card holder name. false
holderNameRequired Set to true to make the card holder name a required field. To show the field, you additionally need to set hasHolderName to true. false
enableStoreDetails Set to true to show the checkbox for saving the card details for recurring payments. false
name String that is used to display the payment method name to the shopper. Depends on the shopperLocale specified in /paymentMethods request.
billingAddressRequired v 3.5.0 Set to true to collect the shopper's billing address. false
const dropin = checkout
   .create('dropin', {
       paymentMethodsConfiguration: {
           card: { // Sample Drop-in configuration for 3D Secure
               hasHolderName: true,
               holderNameRequired: true,
               enableStoreDetails: true,
               name: 'Credit or debit card',
               billingAddressRequired: true

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

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

  1. Pass the to your server.
  2. From your server, make a /payments request, specifying:

    Parameter name Required Description
    paymentMethod -white_check_mark- The object from the onSubmit event.
    paymentMethod.holderName Required for Visa The cardholder's name.
    browserInfo -white_check_mark- The object from the onSubmit event.
    channel -white_check_mark- Set to Web.
    origin -white_check_mark- The origin URL of the page where you are rendering the Drop-in. This should not include subdirectories and a trailing slash. For example, if you are rendering the Drop-in on, specify as the origin.
    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 -white_check_mark- The URL where the shopper will be redirected back to after completing 3D Secure 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. The return URL must not include // (double slash) after the top-level domain. Although you can use a maximum of 1024 characters, we recommend that you keep the number of characters as small as possible.
    billingAddress The object from the onSubmit event.
    shopperIP Required for Visa The shopper's IP address.
    shopperEmail Required for Visa The cardholder's email address. shopperEmail or a phone number is required for Visa.
    Required for Visa A phone number for the shopper, include one of these fields. shopperEmail or a phone number is required for Visa.

For higher authorisation rates, we recommend that you send additional parameters.

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

Description Next steps
No action object The transaction was either exempted or out-of-scope for 3D Secure authentication. Use the resultCode to present the payment result to your shopper.
action object
The payment qualifies for 3D Secure. 1. Pass the action object to your front end.
2. Use dropin.handleAction to handle the redirect.

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

Handle the redirect

Drop-in uses dropin.handleAction(action) to redirect the shopper to a page where we render the issuer's DOM element (the action.url from the /payments response) to perform 3D Secure authentication.

In our test environment, this is the page:, and you perform the authentication using the 3D Secure test credentials:

  • Username: user
  • Password: password

Handle the redirect result

When the shopper completes authentication, the payment is authorized. The shopper is redirected back to the returnUrl from your /payments request. The redirect is via an HTTP GET and is appended with the Base64-encoded redirectResult.

GET /?shopperOrder=12xy...&&redirectResult=X6XtfGC3%21Y.... HTTP/1.1

To verify the payment result, make another API request with the redirectResult parameter:

  1. URL-decode the redirectResult, and pass it to your server.

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

    • details: Object that contains the decoded redirectResult.

The /payments/details response contains:

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:

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