Package com.thalesgroup.gemalto.d1.pushprovisioning

Interface PushProvisioningService

public interface PushProvisioningService

Service interface for push provisioning operations.

Since:

4.4.0

Method Summary

Modifier and Type	Method	Description
void	activateSamsungPay()	Samsung Pay only.
Task<Object>	addDigitalCardToOEM(String cardID, OEMPayType oemType, Activity activity, int options)	Adds a digital card to OEM wallet for a given cardID.
Task<String>	addDigitalCardToScheme(String cardID, TokenRequestor tokenRequestor, String appURL, boolean tcsAccepted)	Adds a digital card to scheme for a given cardID.
Task<CardDigitizationState>	getCardDigitizationState(OEMPayType oemType, String last4)	Gets the digitization state of a card using the last 4 digits.
Task<CardDigitizationState>	getCardDigitizationState(String cardID, OEMPayType oemType)	Gets the digitization state of a card in an OEM wallet.
Task<List<TokenRequestor>>	getTokenRequestorList(String cardID)	Retrieves the eligible token requestor list for a given cardID.
void	updateSamsungPay()	Samsung Pay only.

Method Details

addDigitalCardToScheme

Task<String> addDigitalCardToScheme(@NonNull
 String cardID,
 @NonNull
 TokenRequestor tokenRequestor,
 @NonNull
 String appURL,
 boolean tcsAccepted)

Adds a digital card to scheme for a given cardID.

Possible errors reported when executing the returned Task:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CORE
• D1Exception.ErrorCode.ERROR_CARD

Parameters:

cardID - The card identifier.

tokenRequestor - The token requestor that end user has selected.

appURL - The issuer app's custom URL that is used by the token requestor to redirect the end user back to the issuer app after completing the digitization flow.

tcsAccepted - The terms and conditions accepted by end user.

Returns:

a Task that performs the operation and returns a non-null result on success.

Since:

4.4.0

addDigitalCardToOEM

Task<Object> addDigitalCardToOEM(@NonNull
 String cardID,
 @NonNull
 OEMPayType oemType,
 @Nullable
 Activity activity,
 int options)

Adds a digital card to OEM wallet for a given cardID.

This API provisions a digital card to an OEM wallet (Google Pay or Samsung Pay). The integrator must override Activity.onActivityResult(int, int, android.content.Intent) and pass the result back to SDK using the D1Task.handleCardResult(int, int, android.content.Intent) API.

Possible errors reported when executing the returned Task:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_GPAY_NOT_SUPPORTED
• D1Exception.ErrorCode.ERROR_SPAY_NOT_SUPPORTED
• D1Exception.ErrorCode.ERROR_CORE
• D1Exception.ErrorCode.ERROR_SPAY
• D1Exception.ErrorCode.ERROR_GPAY
• D1Exception.ErrorCode.ERROR_CARD

Parameters:

cardID - The card identifier

oemType - The OEM wallet type (Google Pay or Samsung Pay).

activity - The caller activity. Set this value if the 'activity' value in the deprecated ConfigParams.buildConfigCard(Activity, OEMPayType, String, String) is null or they are different. Otherwise, you can set it to null.

options - This variable is added for future use.

Returns:

a Task that performs the operation and returns null on success.

Throws:

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

IllegalStateException - when core module has not been configured.

Since:

4.4.0

getCardDigitizationState

Task<CardDigitizationState> getCardDigitizationState(@NonNull
 String cardID,
 @NonNull
 OEMPayType oemType)

Gets the digitization state of a card in an OEM wallet.

This API requires a backend call to retrieve the card details before checking the digitization state. Use this API to determine if the Add to Wallet button should be shown in the application.

Possible errors reported when executing the returned Task:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_GPAY_NOT_SUPPORTED
• D1Exception.ErrorCode.ERROR_SPAY_NOT_SUPPORTED
• D1Exception.ErrorCode.ERROR_CORE
• D1Exception.ErrorCode.ERROR_SPAY
• D1Exception.ErrorCode.ERROR_GPAY
• D1Exception.ErrorCode.ERROR_CARD

Parameters:

cardID - The card identifier.

oemType - The OEM wallet type (Google Pay or Samsung Pay).

Returns:

a Task that performs the operation and returns a non-null CardDigitizationState on success.

Throws:

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

IllegalStateException - when core module has not been configured.

Since:

4.4.0

getCardDigitizationState

Task<CardDigitizationState> getCardDigitizationState(@NonNull
 OEMPayType oemType,
 @NonNull
 String last4)

Gets the digitization state of a card using the last 4 digits.

This is a pure offline API that does not require any network call to the D1 backend, providing a quicker response compared to getCardDigitizationState(String, OEMPayType). Use this API to determine if the Add to Wallet button should be shown in the application.

Possible errors reported when executing the returned Task:

• D1Exception.ErrorCode.ERROR_GPAY_NOT_SUPPORTED
• D1Exception.ErrorCode.ERROR_SPAY_NOT_SUPPORTED
• D1Exception.ErrorCode.ERROR_SPAY
• D1Exception.ErrorCode.ERROR_GPAY
• D1Exception.ErrorCode.ERROR_CARD

Parameters:

oemType - The OEM wallet type (Google Pay or Samsung Pay).

last4 - The last 4 digits of the card.

Returns:

a Task that performs the operation and returns a non-null CardDigitizationState on success.

Throws:

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

IllegalStateException - when core module has not been configured.

Since:

4.4.0

activateSamsungPay

void activateSamsungPay()
                 throws D1Exception

Samsung Pay only.

An utility function to bring the Samsung Pay app to a state in which cards can be added. End user needs to sign in to Samsung Pay app.

Throws:

D1Exception - when Samsung Pay is not supported or app is misconfigured

Since:

4.4.0

updateSamsungPay

void updateSamsungPay()
               throws D1Exception

Samsung Pay only.

An utility function to bring a user to update their Samsung Pay app.

Throws:

D1Exception - when Samsung Pay is not supported or app is misconfigured

Since:

4.4.0

getTokenRequestorList

Task<List<TokenRequestor>> getTokenRequestorList(@NonNull
 String cardID)

Retrieves the eligible token requestor list for a given cardID.

Possible errors reported when executing the returned Task:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CORE
• D1Exception.ErrorCode.ERROR_CARD

Parameters:

cardID - The card identifier.

Returns:

a Task that performs the operation and returns a non-null result on success.

Since:

4.4.0