com.adyen.threeds2

Interface ThreeDS2Service

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.

Field Summary

Fields

Modifier and Type	Field and Description
static ThreeDS2Service	INSTANCE The ThreeDS2Service instance.

Method Summary

Modifier and Type	Method and Description
void	cleanup(android.content.Context applicationContext) Frees up resources that are used by the 3DS SDK.
Transaction	createTransaction(java.lang.String directoryServerID, java.lang.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.
java.lang.String	getSDKVersion() Returns the version of the 3DS SDK that is integrated with the App.
java.util.List<Warning>	getWarnings() Returns the security checks warnings produced by the 3DS SDK during initialization.
void	initialize(android.content.Context applicationContext, ConfigParameters configParameters, java.lang.String locale, UiCustomization uiCustomization) Initializes the 3DS SDK service instance.

Field Detail

INSTANCE

static final ThreeDS2Service INSTANCE

The ThreeDS2Service instance.

Method Detail

initialize

void initialize(android.content.Context applicationContext,
                ConfigParameters configParameters,
                java.lang.String locale,
                UiCustomization uiCustomization)
         throws InvalidInputException,
                SDKAlreadyInitializedException,
                SDKRuntimeException

Initializes the 3DS SDK service instance.

Note: Until the ThreeDS2Service instance is initialized, it will be unusable.

During initialization the following tasks are performed:

• Security checks. Retrieved by getWarnings().
• Collection of device information for all versions of the protocol that the SDK supports.

Depending on the App's implementation, a ThreeDS2Service shall be initialized as a background task either during the App startup or when a transaction is initiated. The state of the instance is maintained until the cleanup(android.content.Context) method is called.

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. "en_US"). If set to null, then the default device locale will be used.

uiCustomization - (optional) The UiCustomization, UI configuration information that is used to specify the UI layout and theme. If set to null, then the default app's theme will be used.

Throws:

InvalidInputException - This exception will be thrown in any of the following scenarios:

• configParameters parameter is null.
• The value of configParameters, locale, or uiCustomization is invalid.

SDKAlreadyInitializedException - This exception will be thrown if the 3DS SDK instance has already been initialized.

SDKRuntimeException - This exception will be thrown if an internal error is encountered by the 3DS SDK.

createTransaction

Transaction createTransaction(java.lang.String directoryServerID,
                              @NonNull
                              java.lang.String messageVersion)
                       throws InvalidInputException,
                              SDKNotInitializedException,
                              SDKRuntimeException

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:

An instance of the Transaction interface.

Throws:

InvalidInputException - This exception will be thrown if an input parameter is invalid. This also includes an invalid Directory Server ID or a protocol version that the 3DS SDK does not support.

SDKNotInitializedException - This exception will be thrown if the 3DS SDK instance has not been initialized.

SDKRuntimeException - This exception will be thrown if an internal error is encountered by the 3DS SDK.

cleanup

void cleanup(android.content.Context applicationContext)
      throws SDKNotInitializedException

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.

Throws:

SDKNotInitializedException - This exception will be thrown if the 3DS SDK instance has not been initialized.

getSDKVersion

java.lang.String getSDKVersion()

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

Returns:

The version of the 3DS SDK.

getWarnings

java.util.List<Warning> getWarnings()

Returns the security checks warnings produced by the 3DS SDK during initialization.

Returns:

A List of Warnings.