Default icon

Redirect 3DS Drop-in integration

Support cards with 3D Secure authentication through a redirect in your Android app.

Our Android 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 3D Secure 2 authentication.

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. Check the payment result after the shopper returns to your website.

This page describes the integration steps for Android Drop-in v4.0.0 or later.

Before you begin

This page explains how to add cards with redirect 3D Secure authentication to your existing Android Drop-in integration. The Android 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 you begin your integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payment 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.

Collect additional parameters in your payment form

For higher authentication rates, we strongly recommend that you collect the shopper's billing address and email address in advance in your payment form. Deliver these parameters to your backend when making a payment as they are required by the card schemes.

Show the available cards in your payment form

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

To show cards in your payment form:

  1. Specify in your /paymentMethods request a combination of countryCode and amount.currency. Drop-in uses this information to show the available cards to your shopper.

  2. When creating an instance of Drop-in, create a configuration object, and pass your client key. To make sure you collect the cardholder name, set holderNameRequired to true.

val cardConfiguration = CardConfiguration.Builder(context, "YOUR_CLIENT_KEY")
  // Makes the cardholder name required
  // When you're ready to accept live payments, change the value to one of our live environments.

val dropInConfiguration = DropInConfiguration.Builder(context,, "YOUR_CLIENT_KEY")
   // When you're ready to accept live payments, change the value to one of our live environments.

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

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

    Parameter name Required Description
    paymentMethod -white_check_mark- The paymentComponentData.paymentMethod object from your client app.
    channel -white_check_mark- Set to Android.
    returnUrl -white_check_mark- The URL where the shopper will be redirected back to after completing 3D Secure authentication. Get this URL from Drop-in in the RedirectComponent.getReturnUrl(context). The return URL can be a maximum of 1024 characters and must not include // (double slash) after the top-level domain.
    browserInfo -white_check_mark- Contains the userAgent and acceptHeader fields.
    billingAddress The cardholder's billing address.
    shopperEmail The cardholder's email address.

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

    For channel Android, we recommend including these additional parameters: billingAddress and shopperEmail.

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

Description Next steps
No action object The transaction was either exempted or out-of-scope for 3D Secure 2 authentication. 1. Return DropInServiceResult.Finished, and the resultCode from the /payments response.
2. Use the resultCode to present the payment result to your shopper.
action object
The payment qualifies for 3D Secure. 1. Return DropInServiceResult.Action, and the action object.
2. Check the payment result.

A sample /payments response with action.type: redirect:

Check the payment result

Drop-in redirects the shopper to perform the 3D Secure authentication. When the shopper returns back to your app, Drop-in provides the actionComponentData object.

  1. Pass the actionComponentData.details to your server.

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

    • details: This is the actionComponentData.details from the Component.
    • paymentData: Required if using Checkout API version 66 or earlier: the value from the last API response that you stored locally in the client-side app.

    You receive a response containing:

    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.

For more information and detailed instructions, refer to our Android Drop-in integration guide.

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