Adyen/adyen-3ds2-ios


License
GPL-3.0-or-later

Documentation

3DS2 iOS SDK

With this SDK, you can accept 3D Secure 2.0 payments via Adyen.

This SDK is currently intended for testing purposes only.

Installation

The SDK is available either through CocoaPods or via manual installation.

CocoaPods

  1. Add pod 'Adyen3DS2' to your Podfile.
  2. Run pod install.

Dynamic Framework

Drag the dynamic Adyen3DS2.framework to the Embedded Binaries section in your general target settings. Select "Copy items if needed" when asked.

Static Framework

  1. In Xcode, select "File" and then "Add Files to...".
  2. Select the static Adyen3DS2.framework and check "Copy items if needed", then select "Add".
  3. In Xcode, select "File" and then "Add Files to...".
  4. Select Adyen3DS2.bundle inside Adyen3DS2.framework and check "Copy items if needed", then select "Add".

Usage

Creating a transaction

First, create an instance of ADYServiceParameters with the additional data retrieved from your call to /authorise. Then, use the class method on ADYService to create a transaction.

ADYServiceParameters *parameters = [ADYServiceParameters new];
    [parameters setDirectoryServerIdentifier:...]; // Retrieved from Adyen.
    [parameters setDirectoryServerPublicKey:...]; // Retrieved from Adyen.

[ADYService transactionWithParameters:parameters appearanceConfiguration:nil completionHandler:^(ADYTransaction *transaction, NSArray<ADYWarning *> *warnings, NSError *error) {
    if (transaction) {
        ADYAuthenticationRequestParameters *authenticationRequestParameters = [transaction authenticationRequestParameters];
        // Submit the authenticationRequestParameters to /authorise3ds2.
    } else {
        // An error occurred.
    }
}];

When the completion handler executes, use the transaction's authenticationRequestParameters in your call to /authorise3ds2.

⚠️ Keep a reference to your ADYTransaction instance until the transaction is finished.

Performing a challenge

In case a challenge is required, create an instance of ADYChallengeParameters with values from the additional data retrieved from your call to /authorise3ds2.

NSDictionary *additionalData = ...; // Retrieved from Adyen.
ADYChallengeParameters *parameters = [ADYChallengeParameters challengeParametersWithServerTransactionIdentifier:additionalData[@"threeds2.threeDS2ResponseData.threeDSServerTransID"]
                                                                                       ACSTransactionIdentifier:additionalData[@"threeds2.threeDS2ResponseData.acsTransID"]
                                                                                             ACSReferenceNumber:additionalData[@"threeds2.threeDS2ResponseData.acsReferenceNumber"]
                                                                                               ACSSignedContent:additionalData[@"threeds2.threeDS2ResponseData.acsSignedContent"]];

Use these challenge parameters to perform the challenge with the transaction you created earlier:

[transaction performChallengeWithParameters:parameters completionHandler:^(ADYChallengeResult *result, NSError *error) {
    if (result) {
        NSString *transactionStatus = [result transactionStatus];
        // Submit the transactionStatus to /authorise3ds2.
    } else {
        // An error occurred.
    }
}];

When the challenge is completed successfully, submit the transactionStatus in the result in your second call to /authorise3ds2.

Customizing the UI

The SDK provides some customization options to ensure the UI of the challenge flow fits your app's look and feel. These customization options are available through the ADYAppearanceConfiguration class. To use them, create an instance of ADYAppearanceConfiguration, configure the desired properties and pass it during initialization of the ADYService.

For example, to make the Continue button red and change its corner radius:

ADYAppearanceConfiguration *appearanceConfiguration = [ADYAppearanceConfiguration new];
[[appearanceConfiguration buttonAppearanceForType:ADYAppearanceButtonTypeContinue] setBackgroundColor:[UIColor redColor]];
[[appearanceConfiguration buttonAppearanceForType:ADYAppearanceButtonTypeContinue] setTextColor:[UIColor whiteColor]];
[[appearanceConfiguration buttonAppearanceForType:ADYAppearanceButtonTypeContinue] setCornerRadius:3.0f];

[ADYService transactionWithParameters:parameters appearanceConfiguration:appearanceConfiguration completionHandler:...];

See also

License

This SDK is available under the Apache License, Version 2.0. For more information, see the LICENSE file.