With this SDK, you can accept 3D Secure 2.0 payments via Adyen.
The SDK is available via CocoaPods, Carthage or via manual installation.
- Add
pod 'Adyen3DS2'
to yourPodfile
. - Run
pod install
.
- Add
github "adyen/adyen-3ds2-ios"
to yourCartfile
. - Run
carthage update
. - Link the framework with your target as described in Carthage Readme.
Drag the dynamic Adyen3DS2.framework
to the Embedded Binaries
section in your general target settings. Select "Copy items if needed" when asked.
- In Xcode, select "File" and then "Add Files to...".
- Select the static
Adyen3DS2.framework
and check "Copy items if needed", then select "Add". - In Xcode, select "File" and then "Add Files to...".
- Select
Adyen3DS2.bundle
insideAdyen3DS2.framework
and check "Copy items if needed", then select "Add".
- Follow Apple's Adding Package Dependencies to Your App guide on how to add a Swift Package dependency.
- Use
https://github.com/Adyen/adyen-3ds2-ios
as the repository URL. - Specify the version to be at least
2.2.1
.
Adyen3DS2
using Swift Package Manager.
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 new service. This service can be used to create a new transaction.
ADYServiceParameters *parameters = [ADYServiceParameters new];
[parameters setDirectoryServerIdentifier:...]; // Retrieved from Adyen.
[parameters setDirectoryServerPublicKey:...]; // Retrieved from Adyen.
[parameters setDirectoryServerRootCertificates:...]; // Retrieved from Adyen.
[ADYService serviceWithParameters:parameters appearanceConfiguration:nil completionHandler:^(ADYService *service) {
NSError *error = nil;
ADYTransaction *transaction = [service transactionWithMessageVersion:@"2.1.0" error:&error];
if (transaction) {
ADYAuthenticationRequestParameters *authenticationRequestParameters = [transaction authenticationRequestParameters];
// Submit the authenticationRequestParameters to /authorise3ds2.
} else {
// An error occurred.
}
}];
Use the transaction
's authenticationRequestParameters
in your call to /authorise3ds2
.
[ADYService transactionWithMessageVersion:error:]
requires the message version to be passed, please fill in the same message version as in the AReq, you should be able to get the message version decided by the 3DS server from its response when initiating the payment, if you use the Adyen 3DS server please see the documentation.
ADYTransaction
instance until the transaction is finished.
ADYTransaction
/ADYService
object(s) between scenes for the case if the shopper starts a transaction on one window and switch to another while the transaction is in progress.
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"]
threeDSRequestorAppURL:[NSURL URLWithString:@"{YOUR_CUSTOM_APP_URL}"] // Or nil if for example you're using protocol version 2.1.0
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
.
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 serviceWithParameters:parameters appearanceConfiguration:appearanceConfiguration completionHandler:...];
If you want to get the currently used sdk version - for example to send to the /authorise
end point, you can get it using:
NSString* threeDS2SDKVersion = ADY3DS2SDKVersion();
let threeDS2SDKVersion = ADY3DS2SDKVersion()
This SDK is available under the Apache License, Version 2.0. For more information, see the LICENSE file.