Package com.netcetera.threeds.sdk.api

Interface ThreeDS2Service

public interface ThreeDS2Service

Provides methods to process transactions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ThreeDS2Service.InitializationCallback	3DS SDK Initialization Callback.

Method Summary

Modifier and Type	Method	Description
void	cleanup(android.content.Context applicationContext)	The cleanup method frees up resources that are used by the 3DS SDK.
Transaction	createTransaction(String directoryServerID, String messageVersion)	Creates an instance of Transaction through which the 3DS Requestor App gets the data that is required to perform the transaction.
Transaction	createTransaction(String directoryServerID, String messageVersion, Map<String,String> additionalParameters)	Creates an instance of Transaction through which the 3DS Requestor App gets the data that is required to perform the transaction.
SDKInfo	getSDKInfo()	Provides information of the current configuration with which the 3DS SDK operates.
String	getSDKVersion()
List<Warning>	getWarnings()	Returns warnings produced by the 3DS SDK while performing security checks during initialization.
void	initialize(android.content.Context applicationContext, ConfigParameters configParameters, String locale, UiCustomization uiCustomization)	Deprecated. This is no longer supported since EMVCo Specification 2.3.1.
void	initialize(android.content.Context applicationContext, ConfigParameters configParameters, String locale, Map<UiCustomization.UiCustomizationType,UiCustomization> uiCustomizationMap)	The 3DS requester App calls the initialize method at the start of the payment stage of a transaction.
void	initialize(android.content.Context applicationContext, ConfigParameters configParameters, String locale, Map<UiCustomization.UiCustomizationType,UiCustomization> uiCustomizationMap, ThreeDS2Service.InitializationCallback initializationCallback)	The 3DS requester App calls the initialize method at the start of the payment stage of a transaction.

Method Details

initialize

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

Deprecated.

This is no longer supported since EMVCo Specification 2.3.1. Use initialize(Context, ConfigParameters, String, Map) instead.

The 3DS requester App calls the initialize method at the start of the payment stage of a transaction.

IMPORTANT NOTICE:

• This method must be called on a background thread!

Parameters:

applicationContext - Context

configParameters - ConfigParameters

locale - String, example value “en_US”.

uiCustomization - UiCustomization

Throws:

InvalidInputException - if invalid input is provided.

SDKAlreadyInitializedException - is SDK is already initialized.

SDKRuntimeException - if 3DS SDK encounters internal error.

initialize

void initialize(android.content.Context applicationContext,
 ConfigParameters configParameters,
 String locale,
 Map<UiCustomization.UiCustomizationType,UiCustomization> uiCustomizationMap)
         throws InvalidInputException,
SDKAlreadyInitializedException,
SDKRuntimeException

The 3DS requester App calls the initialize method at the start of the payment stage of a transaction.

IMPORTANT NOTICE:

• This method must be called on a background thread!

Parameters:

applicationContext - Context

configParameters - ConfigParameters

locale - String, example value “en_US”.

uiCustomizationMap - Map of UiCustomization identified by UiCustomization.UiCustomizationType

Throws:

InvalidInputException - if invalid input is provided.

SDKAlreadyInitializedException - is SDK is already initialized.

SDKRuntimeException - if 3DS SDK encounters internal error.

initialize

void initialize(android.content.Context applicationContext,
 ConfigParameters configParameters,
 String locale,
 Map<UiCustomization.UiCustomizationType,UiCustomization> uiCustomizationMap,
 ThreeDS2Service.InitializationCallback initializationCallback)

The 3DS requester App calls the initialize method at the start of the payment stage of a transaction.

IMPORTANT NOTICE:

• This method must be called on a background thread!

Parameters:

applicationContext - Context

configParameters - ConfigParameters

locale - String, example value “en_US”.

uiCustomizationMap - Map of UiCustomization identified by UiCustomization.UiCustomizationType

initializationCallback - ThreeDS2Service.InitializationCallback

getWarnings

List<Warning> getWarnings()
                   throws SDKNotInitializedException

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

Returns:

List of warnings produced by the 3DS SDK during initialization.

Throws:

SDKNotInitializedException - if the 3DS SDK is not initialized.

getSDKVersion

String getSDKVersion()
              throws SDKNotInitializedException,
SDKRuntimeException

Returns:

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

Throws:

SDKNotInitializedException - if the 3DS SDK is not initialized.

SDKRuntimeException - if the SDK experiences internal error while running.

getSDKInfo

SDKInfo getSDKInfo()
            throws SDKNotInitializedException,
SDKRuntimeException

Provides information of the current configuration with which the 3DS SDK operates.

Returns:

SDKInfo

Throws:

SDKNotInitializedException - if the 3DS SDK is not initialized.

SDKRuntimeException - if the SDK experiences internal error while running.

cleanup

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

The cleanup method frees up resources that are used by the 3DS SDK. It is called only once during a single 3DS Requester App session.

Parameters:

applicationContext - Context

Throws:

SDKNotInitializedException - if SDK is not initialized.

createTransaction

Transaction createTransaction(String directoryServerID,
 String messageVersion)
                       throws InvalidInputException,
SDKNotInitializedException,
SDKRuntimeException

Creates an instance of Transaction through which the 3DS Requestor App gets the data that is required to perform the transaction.

Parameters:

directoryServerID - Registered Application Provider Identifier (RID) that is unique to the Payment System.

messageVersion - Protocol version according to which the transaction shall be created.

Returns:

the instance of the Transaction interface.

Throws:

InvalidInputException - if an input parameter is invalid.

SDKNotInitializedException - if SDK is not initialized.

SDKRuntimeException - if an internal error is encountered by the 3DS SDK.

createTransaction

Transaction createTransaction(String directoryServerID,
 String messageVersion,
 Map<String,String> additionalParameters)
                       throws InvalidInputException,
SDKNotInitializedException,
SDKRuntimeException

Creates an instance of Transaction through which the 3DS Requestor App gets the data that is required to perform the transaction.

Parameters:

directoryServerID - Registered Application Provider Identifier (RID) that is unique to the Payment System.

messageVersion - Protocol version according to which the transaction shall be created.

additionalParameters - Additional parameters with which the Transaction should be created. For future use.

Returns:

the instance of the Transaction interface.

Throws:

InvalidInputException - if an input parameter is invalid.

SDKNotInitializedException - if SDK is not initialized.

SDKRuntimeException - if an internal error is encountered by the 3DS SDK.