Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Redirect 3DS Components integration

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

Use our Redirect Component to redirect the shopper to perform 3D Secure 1 or 3D Secure 2 authentication, depending on which version the issuer supports.

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. Contact our Support Team to make sure that 3D Secure is triggered in your app.
  2. Make sure that you have integrated our Card Component, or built you own UI for collecting shopper's card details.
  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 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 holderNameRequire to true when creating a cardConfiguration object:

val cardConfiguration = CardConfiguration.Builder(context, "<publicKey>")
       setHolderNameRequire(true)
          .build()

Make a payment

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

Parameter name Required Description
paymentMethod -white_check_mark- 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.
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 the Component in the RedirectComponent.getReturnUrl(context). The return URL can be a maximum of 1024 characters.
billingAddress The cardholder's billing address.
shopperEmail The cardholder's email address.

To increase the likelihood of achieving a frictionless flow and higher authorisation rates, we recommend that you send additional parameters.

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

curl https://checkout-test.adyen.com/v65/payments \
-H "X-API-key: [Your API Key here]" \
-H "Content-Type: application/json" \
-d '{
   "amount":{
      "currency":"EUR",
      "value":1000
   },
   "reference":"YOUR_ORDER_NUMBER",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "{hint:paymentComponentState.data.paymentMethod from client app}paymentMethod{/hint}":{
      "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"
   },
   "{hint:state.data.billingAddress from onSubmit}billingAddress{/hint}": {
       "street": "Infinite Loop",
       "houseNumberOrName": "1",
       "postalCode": "1011DJ",
       "city": "Amsterdam",
       "country": "NL"
  },
   "shopperEmail":"s.hopper@example.com",
   "channel":"Android",
   "returnUrl":"adyencheckout://your.package.name",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.env = :test
adyen.api_key = "YOUR_X-API-KEY"

response = adyen.checkout.payments({
  :amount => {
    :currency => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID",
  :paymentMethod => {     # Data object passed from Component, parsed from JSON to a Hash.
    :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"
  },
  :billingAddress => {
    :city => "Amsterdam",
    :country => "NL",
    :houseNumberOrName => "1",
    :postalCode => "1011DJ",
    :street => "Infinite Loop"
  },
  :shopperEmail => "s.hopper@example.com",
  :channel => "Android",
  :returnUrl => "https://example.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

# Check if further action is needed.
if response.body.has_key(:action)
   # Pass the action object to your front end
   # response.body[:action]
else
   # No further action needed, pass the resultCode object to your front end
   # response.body[:resultCode]
Client client = new Client("YOUR_API_KEY", Environment.TEST);

  Checkout checkout = new Checkout(client);

  PaymentsRequest paymentsRequest = new PaymentsRequest();

  paymentsRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
  paymentsRequest.setReference("YOUR_ORDER_REFERENCE");

  DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
  paymentMethodDetails.setType("scheme");
  paymentMethodDetails.setEncryptedCardNumber("adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..");
  paymentMethodDetails.setEncryptedExpiryMonth("adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..");
  paymentMethodDetails.setEncryptedExpiryYear("adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..");
  paymentMethodDetails.setEncryptedSecurityCode("adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..");
  paymentMethodDetails.setHolderName("S. Hopper");

  paymentsRequest.setPaymentMethod(paymentMethodDetails);

  Amount amount = new Amount();
  amount.setCurrency("EUR");
  amount.setValue(1000L);

  paymentsRequest.setAmount(amount);

  Address billingAddress = new Address();
  billingAddress.setCity("Amsterdam");
  billingAddress.setCountry("NL");
  billingAddress.setHouseNumberOrName("1");
  billingAddress.setPostalCode("1011DJ");
  billingAddress.setStreet("Infinite Loop");

  paymentsRequest.setBillingAddress(billingAddress);

  paymentsRequest.setShopperEmail("s.hopper@example.com");
  paymentsRequest.setChannel("Android");
  paymentsRequest.setReturnUrl("adyencheckout://your.package.name");

  PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "amount" => [
    "currency" => "EUR",
    "value" => 1000
  ],
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => {
    "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"
  ],
  "billingAddress" => [
    "city" => "Amsterdam",
    "country" => "NL",
    "houseNumberOrName" => "1",
    "postalCode" => "1011DJ",
    "street" => "Infinite Loop"
  ],
  "shopperEmail" = "s.hopper@example.com",
  "channel" => "Android",
  "returnUrl" => "adyencheckout://your.package.name",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
];

$result = $service->payments($params);

// Check if further action is needed
if (array_key_exists("action", $result){
   // Pass the action object to your front end.
   // $result["action"]
}
else {
   // No further action needed, pass the resultCode to your front end
   // $result['resultCode']
}
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
  "amount": {
    "currency": "EUR",
    "value": 1000
  },
  "reference":"YOUR_ORDER_NUMBER",
  "paymentMethod": {
    "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"
  },
  "billingAddress": {
    "street": "Infinite Loop",
    "houseNumberOrName": "1",
    "postalCode": "1011DJ",
    "city": "Amsterdam",
    "country": "NL"
  },
  "shopperEmail": "s.hopper@example.com",
  "channel": "Android",
  "returnUrl": "adyencheckout://your.package.name",
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR-X-API-KEY", Environment.Test);
var checkout = new Checkout(client);
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
    Amount = new Model.Checkout.Amount(Currency: "EUR", Value: 1000),
    Reference = "YOUR_ORDER_REFERENCE",
    PaymentMethod = new DefaultPaymentMethodDetails
    {
        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",
        Type = "scheme"
    },
    BillingAddress = new Model.Checkout.Address
    {
        City = "Amsterdam",
        Country = "NL",
        HouseNumberOrName = "1",
        PostalCode = "1011DJ",
        Street = "Infinite Loop"
    },
    ShopperEmail = "s.hopper@example.com",
    Channel = "Android",
    ReturnUrl = "adyencheckout://your.package.name",
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT"
};
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
  amount:{
    currency: "EUR",
    value: 1000
  },
  reference: "YOUR_ORDER_NUMBER",
  paymentMethod: {
    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"
  },
  billingAddress: {
    city: "Amsterdam",
    country: "NL",
    houseNumberOrName: "1",
    postalCode: "1011DJ",
    street: "Infinite Loop"
  },
  shopperEmail: "s.hopper@example.com",
  channel: "Android",
  returnUrl: "adyencheckout://your.package.name",
  merchantAccount: "YOUR_MERCHANT_ACCOUNT"
}).then(res => res);

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. Use the resultCode to present the payment result to your shopper.
action object
type:redirect
The payment qualifies for 3D Secure. 1. Store the action.paymentData on your server.
2. Pass the action object to your client app.
2. Use the Redirect Component to handle the redirect.

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

/payments response
{
    "resultCode": "RedirectShopper",
    "action": {
        "paymentData": "Ab02b4c0!BQABAgAb/5/AMms/...==",
        "paymentMethodType": "scheme",
        "url": "https://test.adyen.com/hpp/3d-redirect-checkout-direct-api.shtml?brandCode=...",
        "method": "GET",
        "type": "redirect"
    },
    "details": [
        {
            "key": "MD",
            "type": "text"
        },
        {
            "key": "PaRes",
            "type": "text"
        }
    ],
    ...
    }
}

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 /payments/details request from your server, specifying:

    • details: The actionComponentData.details from your client app.
    • paymentData: The value from from the /payments response.
    curl https://checkout-test.adyen.com/v65/payments/details \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
      "{hint:actionComponentData.details from app}details{/hint}": {
        "MD":"OEVudmZVMUlkWjd0MDNwUWs2bmhSdz09...",
        "PaRes": "sdkfhskdjfsdf..."
      },
      "{hint:Value from the /payments response}paymentData{/hint}":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj..."
    }'
    # Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen::Client.new
    adyen.env = :test
    adyen.api_key = "YOUR_X-API-KEY"
    
    request = DROPIN_ACTION_COMPONENT_DATA
    #  Data object passed from actionComponentData from the client app, parsed from JSON to a Hash.
    
    response = adyen.checkout.payments.details(request)
    
    # Check if further action is needed.
    if response.body.has_key(:action)
       # Pass the action object to your frontend
       puts response.body[:action]
    else
       # No further action needed, pass the resultCode to your frontend
       puts response.body[:resultCode]
    end
    // Set your X-API-KEY with the API key from the Customer Area.
    Client client = new Client(xApiKey,Environment.TEST);
    
    Checkout checkout = new Checkout(client);
    PaymentsDetailsRequest paymentsDetailsRequest = new PaymentsDetailsRequest();
    HashMap<String, String> details = new HashMap<>();
    details.put("MD", "OEVudmZVMUlkWjd0MDNwUWs2bmhSdz09...");
    details.put("PaRes", "sdkfhskdjfsdf...");
    paymentsDetailsRequest.setDetails(details);
    paymentsDetailsRequest.setPaymentData("Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...");
    PaymentsResponse paymentsResponse = checkout.paymentsDetails(paymentsDetailsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    $client = new \Adyen\Client();
    $client->setXApiKey("YOUR_X-API-KEY");
    $service = new \Adyen\Service\Checkout($client);
    
    $params = DROPIN_ACTION_COMPONENT_DATA;
    //  Data object passed from actionComponentData from the client app, parsed from JSON to an array
    
    $result = $service->paymentsDetails($params);
    
    // Check if further action is needed
    if (array_key_exists("action", $result){
       // Pass the action object to your frontend.
       // $result["action"]
    }
    else {
       // No further action needed, pass the resultCode to your front end
       // $result['resultCode']
    }
    #Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen.Adyen()
    adyen.client.xapikey = 'YOUR_X-API-KEY'
    
    request = DROPIN_ACTION_COMPONENT_DATA
    #  Data object passed from actionComponentData from the client app, parsed from JSON to a dictionary
    
    result = adyen.checkout.payments_details(request)
    
    # Check if further action is needed.
    if 'action' in result.message:
       # Pass the action object to your front end
       # result.message['action']
    else:
       # No further action needed, pass the resultCode to your front end
       # result.message['resultCode']
    // Set your X-API-KEY with the API key from the Customer Area.
    var client = new Client ("YOUR_X-API-KEY", Environment.Test);
    var checkout = new Checkout(client);
    string paymentData = "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...";
    var details = new Dictionary<string, string>
    {
      { "MD", "OEVudmZVMUlkWjd0MDNwUWs2bmhSdz09" },
      { "PaRes", "sdkfhskdjfsdf..." }
    };
    var paymentsDetailsRequest = new Model.Checkout.PaymentsDetailsRequest(Details: details, PaymentData: paymentData);
    var paymentResponse = checkout.PaymentDetails(paymentsDetailsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
    const config = new Config();
    // Set your X-API-KEY with the API key from the Customer Area.
    config.apiKey = '[API_KEY]';
    config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
    const client = new Client({ config });
    client.setEnvironment("TEST");
    const checkout = new CheckoutAPI(client);
    checkout.paymentsDetails({
      details: {COMPONENT_DATA_DETAILS}  // Data object passed from the client app
      paymentData: "Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj..."  // Value from your last API response
    }).then(res => res);

    You receive a response containing:

    /payments/details response
    {
     "resultCode": "Authorised",
     "pspReference": "88154795347618C"
    }

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 notification 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 whether 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