Package com.thalesgroup.gemalto.d1

Class D1Task

java.lang.Object

com.thalesgroup.gemalto.d1.D1Task

public class D1Task
extends Object

Main class for D1 use cases.

NOTE:
It is recommended to initialize D1Task as soon as the application is launched or the earliest possible time.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	D1Task.Builder	An object that constructs D1Task from its configurations.
static interface	D1Task.Callback<T>	Generic callback to return result of an asynchronous call.
static interface	D1Task.ConfigCallback<T>	Configuration callback to return result of an asynchronous call.

Method Summary

Modifier and Type	Method	Description
void	activateDigitalCard(String cardID, D1Task.Callback<Void> callback)	Google Pay only.
void	activatePhysicalCard(String cardID, EntryUI entryUI, D1Task.Callback<Void> callback)	Activate a Physical Card.
void	addDigitalCardToOEM(String cardID, D1Task.Callback<Void> callback)	Add Digital Card for a given cardID for OEM Type (Google Pay or Samsung Pay).
void	addDigitalCardToScheme(String cardID, TokenRequestor tokenRequestor, String appURL, boolean tcsAccepted, D1Task.Callback<String> callback)	Add Digital Card to scheme for a given cardID
void	configure(D1Task.ConfigCallback<Void> callback, D1Params... configParams)	D1 Task configurations.
void	displayCardDetails(String cardID, CardDetailsUI cardDetailsUI, D1Task.Callback<Void> callback)	Display Card Details information securely.
void	displayPhysicalCardPIN(String cardID, CardPINUI cardPINUI, D1Task.Callback<Void> callback)	Display the PIN for a Physical Card.
void	getCardActivationMethod(String cardID, D1Task.Callback<CardActivationMethod> callback)	Retrieve the activation method for a Physical Card.
void	getCardDetails(String cardID, D1Task.Callback<CardDetails> callback)	Retrieve detail information of the card, including full PAN value.
void	getCardDigitizationState(String cardID, D1Task.Callback<CardDigitizationState> callback)	Check if the card has been digitized or not.
void	getCardMetadata(String cardID, D1Task.Callback<CardMetadata> callback)	Retrieve basic card metadata.
D1PayWallet	getD1PayWallet()	Retrieve D1PayWallet object for D1 Payment use cases
void	getDigitalCardList(String cardID, D1Task.Callback<List<DigitalCard>> callback)	Retrieve Digital Card list for a given cardID.
void	getPhysicalCardPIN(String cardID, D1Task.Callback<byte[]> callback)	Retrieve the PIN for a Physical Card.
static Map<String,String>	getSDKVersions()	Returns SDK version(s) in the D1 SDK.
void	getTokenRequestorList(String cardID, D1Task.Callback<List<TokenRequestor>> callback)	Retrieve eligible token requestor list for a given cardID.
void	handleCardResult(int requestCode, int resultCode, Intent data)	Handle data that Wallet has returned for card operation.
void	login(byte[] issuerToken, D1Task.Callback<Void> callback)	Login to the D1 services using a provided token.
void	logout(D1Task.Callback<Void> callback)	Logout to the D1 services
void	processPushMessage(Map<String,String> data, D1Task.Callback<String> callback)	Process the pushed data received from notification server
void	registerCardDataChangedListener(CardDataChangedListener listener)	Register to receive Card/Wallet update on following events: The active wallet changes (by changing the active account) The selected card of the active wallet changes Tokenized cards are added or removed from the active wallet The status of a token in the active wallet changes
void	unRegisterCardDataChangedListener()	Unregister the Card/Wallet data changed listener
void	updateCard(String cardID, CardAction cardAction, String reason, D1Task.Callback<Void> callback)	Update the Virtual Card state.
void	updateDigitalCard(String cardID, DigitalCard digitalCard, CardAction cardAction, D1Task.Callback<Boolean> callback)	Update Digital Card status for a given Digital card ID.
void	updatePushToken(String token, D1Task.Callback<Void> callback)	Update new push token

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSDKVersions

@NonNull
public static Map<String,String> getSDKVersions()

Returns SDK version(s) in the D1 SDK.

Returns:

Dictionary with SDK name as key and SDK version as value, e.g. {"D1Core": "1.0.0"}.

configure

public void configure(@NonNull
                      D1Task.ConfigCallback<Void> callback,
                      @NonNull
                      D1Params... configParams)

D1 Task configurations. It is the entry point for SDK initialization.

App can only initialize certain feature only to reduce waiting time. It is not mandatory to initialize all features in a single call.

Parameters:

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.ConfigCallback.onSuccess(Object) is always null.

configParams - The configurations

login

public void login(@NonNull
                  byte[] issuerToken,
                  @NonNull
                  D1Task.Callback<Void> callback)

Login to the D1 services using a provided token.

Parameters:

issuerToken - Issuer token received from the bank IDP

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always null.

logout

public void logout(@NonNull
                   D1Task.Callback<Void> callback)

Logout to the D1 services

Parameters:

callback - The callback for result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always null.

getCardMetadata

public void getCardMetadata(@NonNull
                            String cardID,
                            @NonNull
                            D1Task.Callback<CardMetadata> callback)

Retrieve basic card metadata. Use this API to retrieve last 4 PAN digit value & Card Art.

Parameters:

cardID - The card identifier

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

getCardDetails

public void getCardDetails(@NonNull
                           String cardID,
                           @NonNull
                           D1Task.Callback<CardDetails> callback)

Retrieve detail information of the card, including full PAN value. These values can be used for online transaction.

Parameters:

cardID - The card identifier

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

displayCardDetails

public void displayCardDetails(@NonNull
                               String cardID,
                               @NonNull
                               CardDetailsUI cardDetailsUI,
                               @NonNull
                               D1Task.Callback<Void> callback)

Display Card Details information securely.

Use this API to display full card information. Using UI component in CardDetailsUI the API sets the Card Details information in the UI. Integrator has full control of UI appearance and layout.

Parameters:

cardID - The card identifier.

cardDetailsUI - The UI to display card details.

callback - The callback invoked when the operation is completed. When it succeeds, it returns no error. Otherwise, it returns error details.

Since:

2.1.0

updateCard

public void updateCard(@NonNull
                       String cardID,
                       @NonNull
                       CardAction cardAction,
                       @Nullable
                       String reason,
                       @NonNull
                       D1Task.Callback<Void> callback)

Update the Virtual Card state.

The following CardAction can be performed:

• Resume the card
• Suspend the card

Parameters:

cardID - The card identifier

cardAction - The card action to be performed, possible actions:

• CardAction.RESUME
• CardAction.SUSPEND

reason - The reason for the operation

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always null.

getPhysicalCardPIN

public void getPhysicalCardPIN(@NonNull
                               String cardID,
                               @NonNull
                               D1Task.Callback<byte[]> callback)

Retrieve the PIN for a Physical Card.

Parameters:

cardID - The card identifier

callback - The callback invoked when the operation is completed. When it succeeds, it returns the PIN (D1Task.Callback.onSuccess(Object)). Otherwise, it returns the error details.

Throws:

IllegalArgumentException - when one of the parameters is null or empty.

Since:

1.1.0

displayPhysicalCardPIN

public void displayPhysicalCardPIN(@NonNull
                                   String cardID,
                                   @NonNull
                                   CardPINUI cardPINUI,
                                   @NonNull
                                   D1Task.Callback<Void> callback)

Display the PIN for a Physical Card.

Parameters:

cardID - The card identifier

cardPINUI - The ui to display card PIN

callback - The callback invoked when the operation is completed. When it succeeds, it returns no error and the D1Task.Callback.onSuccess(Object)'s argument is always null. Otherwise, it returns the error details.

Throws:

IllegalArgumentException - when one of the parameters is null or empty.

Since:

1.1.0

getCardActivationMethod

public void getCardActivationMethod(@NonNull
                                    String cardID,
                                    @NonNull
                                    D1Task.Callback<CardActivationMethod> callback)

Retrieve the activation method for a Physical Card.

Parameters:

cardID - The card identifier

callback - The callback invoked when the operation is completed. When it succeeds, it returns the CardActivationMethod. Otherwise, it returns the error details.

Throws:

IllegalArgumentException - when one of the parameters is null or empty.

Since:

1.1.0

activatePhysicalCard

public void activatePhysicalCard(@NonNull
                                 String cardID,
                                 @NonNull
                                 EntryUI entryUI,
                                 @NonNull
                                 D1Task.Callback<Void> callback)

Activate a Physical Card.

Parameters:

cardID - The card identifier

entryUI - The UI to display secure text entry. If activationMethod is CardActivationMethod.NOTHING, construct EntryUI with a null `SecureEditText`

callback - The callback invoked when the operation is completed. When it succeeds, it returns no error. Otherwise, it returns the error details.

Throws:

IllegalArgumentException - when one of the parameters is null or empty.

Since:

1.1.0

getCardDigitizationState

public void getCardDigitizationState(@NonNull
                                     String cardID,
                                     @NonNull
                                     D1Task.Callback<CardDigitizationState> callback)

Check if the card has been digitized or not. Use this API to determine if we need to show Add to Wallet button on the Application.

Parameters:

cardID - The card identifier

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

addDigitalCardToOEM

public void addDigitalCardToOEM(@NonNull
                                String cardID,
                                @NonNull
                                D1Task.Callback<Void> callback)

Add Digital Card for a given cardID for OEM Type (Google Pay or Samsung Pay). OEM Type is set on ConfigParams.buildConfigCard(android.app.Activity, OEMPayType, String)

Integrator must override the Activity.onActivityResult() and pass the result back to SDK using handleCardResult(int, int, Intent) API

Parameters:

cardID - The card identifier

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always null.

See Also:

ConfigParams.buildConfigCard(android.app.Activity, OEMPayType, String), handleCardResult(int, int, Intent)

activateDigitalCard

public void activateDigitalCard(@NonNull
                                String cardID,
                                @NonNull
                                D1Task.Callback<Void> callback)

Google Pay only.

Activate the digital card which has been digitized but not yet done ID&V (Step up authentication - Yellow Flow inApp Verification).

Integrator should call this API when the return state of getCardDigitizationState(String, Callback) is CardDigitizationState.PENDING_IDV

Parameters:

cardID - The card ID

callback - The callback for result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always null.

getDigitalCardList

public void getDigitalCardList(@NonNull
                               String cardID,
                               @NonNull
                               D1Task.Callback<List<DigitalCard>> callback)

Retrieve Digital Card list for a given cardID.

Parameters:

cardID - The card identifier

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

updateDigitalCard

public void updateDigitalCard(@NonNull
                              String cardID,
                              @NonNull
                              DigitalCard digitalCard,
                              @NonNull
                              CardAction cardAction,
                              @NonNull
                              D1Task.Callback<Boolean> callback)

Update Digital Card status for a given Digital card ID.

Parameters:

cardID - The card identifier

digitalCard - The digital card received from getDigitalCardList(String, Callback)

cardAction - The card action to be performed: active, suspend or delete

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

handleCardResult

public void handleCardResult(int requestCode,
                             int resultCode,
                             @Nullable
                             Intent data)

Handle data that Wallet has returned for card operation.

Parameters:

requestCode - The requestCode available for card operation result

resultCode - The resultCode available for card operation result

data - The data available for card operation result

registerCardDataChangedListener

public void registerCardDataChangedListener(@NonNull
                                            CardDataChangedListener listener)

Register to receive Card/Wallet update on following events:

• The active wallet changes (by changing the active account)
• The selected card of the active wallet changes
• Tokenized cards are added or removed from the active wallet
• The status of a token in the active wallet changes

Note: Only foreground applications will be notified.

Therefore, application should update the token status not only when receiving this callback but also when the application launches or returns to the foreground.

For more information, refer to Android Push Provisioning API - Data Change Callbacks

Parameters:

listener - The callback

unRegisterCardDataChangedListener

public void unRegisterCardDataChangedListener()

Unregister the Card/Wallet data changed listener

See Also:

CardDataChangedListener

getTokenRequestorList

public void getTokenRequestorList(@NonNull
                                  String cardID,
                                  @NonNull
                                  D1Task.Callback<List<TokenRequestor>> callback)

Retrieve eligible token requestor list for a given cardID.

Parameters:

cardID - The card identifier

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

Throws:

IllegalArgumentException - when one of the parameter is null or empty

IllegalStateException - when core module has not been configured

Since:

2.0.0

addDigitalCardToScheme

public void addDigitalCardToScheme(@NonNull
                                   String cardID,
                                   @NonNull
                                   TokenRequestor tokenRequestor,
                                   @NonNull
                                   String appURL,
                                   boolean tcsAccepted,
                                   @NonNull
                                   D1Task.Callback<String> callback)

Add Digital Card to scheme for a given cardID

Parameters:

cardID - The card identifier

tokenRequestor - The token requestor that user has selected

appURL - The issuer app's custom URL that the token requestor calls back upon completion of digitization flow to return the user to where they started their journey

tcsAccepted - The terms and conditions accepted by user

callback - The callback for the result. When it succeeds, the returned argument of the D1Task.Callback.onSuccess(Object) is always non-null.

Throws:

IllegalArgumentException - when one of the parameter is null or empty

IllegalStateException - when core module has not been configured

Since:

2.0.0

updatePushToken

public void updatePushToken(@NonNull
                            String token,
                            @NonNull
                            D1Task.Callback<Void> callback)

Update new push token

Parameters:

token - The latest push notification token

callback - The callback for the result

Since:

2.0.0

processPushMessage

public void processPushMessage(@NonNull
                               Map<String,String> data,
                               @NonNull
                               D1Task.Callback<String> callback)

Process the pushed data received from notification server

Parameters:

data - The pushed data

callback - The callback for the result

Since:

2.0.0

getD1PayWallet

@NonNull
public D1PayWallet getD1PayWallet()

Retrieve D1PayWallet object for D1 Payment use cases

Since:

2.0.0