Package com.adyen.threeds2

Interface ThreeDS2Service

  • All Implemented Interfaces:
    
public interface ThreeDS2Service

    The ThreeDS2Service interface is the main 3DS SDK interface. It provides methods to process 3DS transactions.

    Use INSTANCE to get the ThreeDS2Service instance.

    Created by Ran Haveshush on 24/08/2018.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • initialize

         abstract InitializeResult initialize(Context applicationContext, ConfigParameters configParameters, String locale, UiCustomization uiCustomization)

        Initializes the 3DS SDK service instance. Until the ThreeDS2Service instance is initialized, it is unusable.

        During initialization the following tasks are performed:

        • Security checks. Retrieved by getWarnings.
        • Collection of device information for the version of the protocol that the SDK supports.
        The ThreeDS2Service shall be initialized as a background task when a transaction is initiated. The state of the instance is maintained until the cleanup method is called.NOTE: Make sure to call cleanup after every transaction.
        Parameters:
        applicationContext - An instance of Android Application context.
        configParameters - The ConfigParameters, configuration information that shall be used during initialization.
        locale - (optional) A String that represents the app’s user interface locale (e.g.
        uiCustomization - (optional) The UiCustomization, UI configuration information that is used to specify the UI layout and theme.
        Returns:

        The InitializeResult. When the result is InitializeResult.Success the ThreeDS2Service is initialized successfully; proceed with creating a Transaction. When the result is InitializeResult.Failure an error occurred and the transactionStatus and additionalDetails are made available to be sent to Adyen Server.

      • createTransaction

         abstract TransactionResult createTransaction(String directoryServerID, @NonNull() String messageVersion)

        Creates an instance of Transaction through which the App gets the data required to perform the transaction. The App shall call this method for each transaction that is to be processed.

        Parameters:
        directoryServerID - The Registered Application Provider Identifier (RID) that is unique to the Payment System.
        messageVersion - The Protocol version according to which the transaction shall be created.
        Returns:

        The TransactionResult. When the result is TransactionResult.Success the Transaction is created successfully; When the result is TransactionResult.Failure an error occurred and the transactionStatus and additionalDetails are made available to be sent to Adyen Server.

      • cleanup

         abstract void cleanup(Context applicationContext)

        Frees up resources that are used by the 3DS SDK. It is called only once during a single App session.

        Parameters:
        applicationContext - An instance of Android Application context.

      • getSDKVersion

         abstract String getSDKVersion()

        Returns the version of the 3DS SDK that is integrated with the App.

        Returns:

        The version of the 3DS SDK.