Our iOS Drop-in renders the available cards in your payment form, and securely collects any sensitive card information, so it doesn't touch your server. Drop-in also handles the 3D Secure 2 device fingerprinting and challenge flows, including the data exchange between your front end and the issuer's Access Control Server (ACS).
When making a card payment with native 3D Secure 2 authentication, you need to:
- Configure Drop-in to collect the cardholder name.
- Provide additional parameters when making a payment request.
- Submit authentication results if you receive an
action
object in response to your /payments or /payments/details request. - If the payment was routed to 3D Secure 2 redirect flow, handle the redirect result.
Use v4.10.2 or later of iOS Drop-in to trigger the native 3D Secure 2 flow and ensure best performance. We recommend you always use the latest Drop-in version.
Requirements
This page explains how to add cards with native 3D Secure 2 authentication to your existing iOS Drop-in integration. The iOS Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.
Before starting your integration:
- Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
- Add the cards that you want to accept in your test Customer Area.
Collect additional parameters in your payment form
For higher authentication rates, we strongly recommend that you collect the shopper cardholder name and billing address in advance in your payment form. Deliver these parameters to your backend when making a payment, because they are required by the card schemes.
Show the available cards in your payment form
For information about the supported countries/regions and currencies for each card, refer to Payment methods.
To show cards in your payment form:
-
Specify in your /paymentMethods request a combination of countryCode and amount.currency. Drop-in uses this information to show the available cards to your shopper.
-
When initializing the Drop-in, create a configuration object, and specify:
configuration.card.showsHolderNameField
: true. This shows the input field for the cardholder name.
-
If you want to set
ThreeDSRequestorAppURL
, create a configuration object and specifyactionComponent.threeDS.requestorAppURL
. Always use a universal link if you setThreeDSRequestorAppURL
.let configuration = DropInComponent.Configuration(apiContext: apiContext) configuration.card.showsHolderNameField = true // Displays the field for entering the holder name. configuration.actionComponent.threeDS.requestorAppURL = URL(string: "YOUR_APP_URL") // Optional, add a universal link here when you want to send ThreeDSRequestorAppURL
When the shopper is entering their card details, Drop-in tries to recognize the card brand. When successful, Drop-in renders the brand icon.
Make a payment
When the shopper proceeds to pay, Drop-in invokes the didSubmit
method which contains data.paymentMethod
.
- Pass
data.paymentMethod
to your server. - From your server, make a /payments request, specifying:
To increase the likelihood of achieving a frictionless flow and higher authorisation rates, we recommend that you send additional parameters if you have the data available. Do not send placeholder data in the live environment.
For channel
iOS, we recommend including these additional parameters: billingAddress
, shopperEmail
and shopperIP
.
Your next steps depend on whether the /payments response contains an action
object, and on the action.type
. Choose your API version:
Submit authentication results
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.
Troubleshooting
If native 3D Secure 2 is not triggered, check that:
- Your Drop-in version is 4.10.2 or later
paymentMethod.threeDs2SdkVersion
is populated and sent in payment requestchannel
is set to iOSauthenticationData.threeDSRequestData.nativeThreeDS
is set to preferred if you use Checkout API v69 or later ORadditionalData.allow3DS2
is set to true if you use Checkout API v68 or earlier