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

Requirements

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 cardholder name for payments with 3D Secure authentication.

To collect the cardholder name using our Card Component, specify the following when adding the Card Component:

• showsHolderNameField: true

Copy code
let configuration = CardComponent.Configuration(showsHolderNameField: true)
let component =  CardComponent(paymentMethod: paymentMethod,
                                   apiContext: apiContext,
                                   configuration: configuration)
component.delegate = self
self.cardComponent = component
present(component.viewController, animated: true)

We also recommend that you collect the shopper billing address in advance in your payment form. Deliver this parameter to your backend when making a payment as it is required by the card schemes.

Make a payment

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

Parameter name	Required	Description
paymentMethod		If using the Card Component, pass the data.paymentMethod from the didSubmit event 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 iOS.
returnUrl		The URL where the shopper will be redirected back to after completing 3D Secure authentication. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation. The return URL can be a maximum of 1024 characters and must not include // (double slash) after the top-level domain.
browserInfo		The shopper's browser information, include the following fields: acceptHeader: The accept header value of the shopper's browser. You can use a dummy value. userAgent: Get it using BrowserInfo.initialize .
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.

curl https://checkout-test.adyen.com/checkout/v69/payments \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'content-type: application/json' \
-d '{
   "amount":{
      "currency":"EUR",
      "value":1000
   },
   "reference":"YOUR_ORDER_NUMBER",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "paymentMethodstate.data.paymentMethod from didSubmit":{
      "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"
   },
   "billingAddressstate.data.billingAddress from onSubmit": {
      "street": "Infinite Loop",
      "houseNumberOrName": "1",
      "postalCode": "1011DJ",
      "city": "Amsterdam",
      "country": "NL"
   },
   "browserInfo": {
      "userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Mobile/15A5370a Safari/604.1",
      "acceptHeader":"text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8"
   },
   "shopperEmail":"s.hopper@example.com",
   "channel":"iOS",
   "returnUrl":"my-app://adyen",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
}'

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

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

{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentMethodType":"scheme",
      "type":"redirect",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect?MD=M2R..."
   },
   ...
}

Handle the redirect

Use the Redirect Component to redirect the shopper to complete the 3D Secure authentication.

1. Create and persist an instance of the Redirect Component.

   Copy code
   let component = RedirectComponent(apiContext: apiContext)
   component.delegate = delegate
   component.presentationDelegate = presentationDelegate
   self.redirectComponent = component

   Than use it to handle the action:

   Copy code
   let action = try JSONDecoder().decode(Action.self, from: actionData)
   redirectComponent.handle(action)

2. You then need to inform the Component when shopper returns to your app. To do this, implement the following in your UIApplicationDelegate:

   Copy code
   func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
   RedirectComponent.applicationDidOpen(from: url)
   return true
   }

   After the Redirect Component completes the action, it invokes the didProvide method.

3. From your server, make a POST /payments/details request providing the data from the didProvide method from your client app.

   On Checkout API v67 and later, the payment is authorized after the shopper completes authentication. You make a /payments/details request to get the payment result. On earlier versions, you need to complete the payment by making a /payments/details request containing payment data.

   curlJavaPHPC#NodeJS (JavaScript)PythonRubycurlJavaPHPC#NodeJS (JavaScript)PythonRuby

   Expand view

   Copy link to code block

   Copy code

   Copy code

   curl https://checkout-test.adyen.com/checkout/v69/payments/details \
   -H 'x-api-key: ADYEN_API_KEY' \
   -H 'content-type: application/json' \
   -d 'STATE_DATAobject passed from the front end or client app'

   You receive a response containing:

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

   Expand view

   Copy link to code block

   Copy code

   Copy code

   {
     "resultCode": "Authorised",
     "pspReference": "V4HZ4RBFJGXXGN82"
   }

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