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

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

1. When you make a payment request, include the following additional 3D Secure 2 parameters.

   See additional 3D Secure 2 parameters that we recommend to include in your request to increase authentication performance in our API reference.

   Parameter name	Required	Description
   paymentMethod		The type and required details for a card payment method. When using the Card Component, pass the data.paymentMethod from the didSubmit event from your client app. When submitting raw card data, refer to Raw card data for the fields that you need to pass.
   paymentMethod.holderName		Use case: required for Visa and JCB transactions. The cardholder's name.
   channel		The platform where the transaction takes place. 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. Format: Maximum characters: 1024. Must not include // (double slash) after the top-level domain.
   browserInfo		The shopper's browser information. The following sub-fields are required: acceptHeader: The accept header value of the shopper's browser. You can use a dummy value. userAgent: Get it using BrowserInfo.initialize .
   shopperIP		Use case: required for Visa and JCB transactions. The shopper's IP address.
   shopperEmail		Use case: required for Visa and JCB transactions. The cardholder's email address. If you do not include the shopper email, you must include the shopper's phone number in your request.
   telephoneNumber		Use case: required for Visa and JCB transactions if you did not include the shopperEmail field. The shopper's phone number. To be more specific, you can use the mobilePhone, homePhone, and workPhone fields in the threeDS2RequestData object. Format: The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). Example: +4912345678901 If the value you provide does not follow the guidelines, we drop the value and do not submit it for authentication.

   Required for all transactions.       Required for particular setups, or issuers and card schemes.

2. In the response, check if there is an action object. Your next steps depend on whether the response contains an action object, and on the action.type.

   	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 type:redirect	The payment qualifies for 3D Secure.	1. 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:

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.

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

   Than use it to handle the action:

   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:

   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.

   You receive a response containing:

   • resultCode: Use this to present the 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