Redirect 3DS Components integration

Use our Redirect Component to redirect 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. Collect the additional parameters in your payment form and configure the card component.
2. Provide the required 3D Secure parameters when making a payment request.
3. Use the Redirect Component to handle the redirect.

Before you begin

Before starting your integration:

1. Make sure that you have integrated our Card Component, or built your own UI for collecting shopper's card details.
2. 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 card holder name, the shopper 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.

Configure the Card Component

If you are using our Card Component, set holderNameRequired to true when creating a cardConfiguration object:

val cardConfiguration = CardConfiguration.Builder(context, "YOUR_CLIENT_KEY")
    .setHolderNameRequired(true)
    // When you're ready to accept live payments, change the value to one of our live environments.
    .setEnvironment(Environment.TEST)
    .build()

Make a payment

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

Parameter name	Required	Description
paymentMethod		If using the Card Component, pass the paymentComponentState.data.paymentMethod object from your client app. If submitting raw card data, refer to Raw card data for the fields that you need to pass.
paymentMethod.holderName	Required for Visa	The cardholder's name.
channel		Set to Android.
returnUrl		The URL where the shopper will be redirected back to after completing 3D Secure authentication. Get this URL from the Component 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		Contains the userAgent and acceptHeader fields.
billingAddress		The cardholder's billing address.
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.
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.

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

Handle the redirect

1. Use the Redirect Component to redirect the shopper to complete the 3D Secure authentication. When the shopper returns back to your app, the Redirect Component provides the actionComponentData object.

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 payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.

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:

Test and go live

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

See also