Default icon

Redirect 3DS Components integration

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

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.

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

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

Parameter name Required Description
paymentMethod -white_check_mark- 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.
channel -white_check_mark- Set to iOS.
returnUrl -white_check_mark- 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 -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 iOS, 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 authentication. Use the resultCode to present the payment result to your shopper.
action object
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)
  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.

    You receive a response containing:

For more information and detailed instructions, refer to Using the Redirect Component.

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