Package com.thalesgroup.tpcsdk.provisioning

Class PushProvisioning<T>

java.lang.Object

com.thalesgroup.tpcsdk.provisioning.PushProvisioning<T>

public abstract class PushProvisioning<T>
extends Object

Generic parameterized PushProvisioning is an interface which enforce push provisioning operations to be implemented by OEM type OEMPayType The key functions this interface provides are isCardDigitized and addCard to OEM wallets like Google Pay or Samsung Pay

Since:

1.0

Version:

1.1

Constructor Summary

Constructors

Constructor	Description
PushProvisioning()

Method Summary

Modifier and Type	Method	Description
void	activateCardWithIdv(CardInfo cardInfo, String tokenReferenceId, TPCSDKListener<CardDigitizationStatus> listener)	This API is to resume ID&V step for those cards with which, digitization is initialized but ID&V step isn't completed.
void	activateSamsungPay()	An utility function to bring the Samsung Pay app to a state in which cards can be added.
void	addCard(Activity activity, CardInfo cardInfo, TPCSDKListener<T> listener)	This Api helps to add card for Google Pay OEMPayType.GOOGLE_PAY wallet.
void	addCard(CardInfo cardInfo, TPCSDKListener<T> listener)	This Api helps to add card in selected OEMPayType wallet.
void	addCard(CardInfo cardInfo, String publicKeyId, boolean tcsAccepted, CallbackObject callbackObject, String pushHandler, TPCSDKListener<String> listener)	Deprecated. Please use new API: TSHProxy.addCard(CardInfo, String, boolean, CallbackObject, String, TPCSDKListener)
void	getToken(GetTokenInput input, TPCSDKListener<Token> listener)	This method is used to retrieve respective digital token from any of the supported OEM wallets.
void	handleWalletResult(int requestCode, int resultCode, Intent data)	Handle a callback data that Google Pay is returned to Activity.onActivityResult(int, int, Intent).
void	handleWalletResult(Intent data)	Handle a callback data that Huawei Pay Wallet is returned to Activity.onNewIntent(Intent).
void	isCardDigitized(CardInfo cardInfo, TPCSDKListener<CardDigitizationStatus> listener)	The TPC SDK Api is used to check whether given card is already digitized in any of the supported OEM wallets.
void	registerDataChangedListener(TPCSDKDataChangedListener dataChangedListener)	Google Pay Only.
void	removeDataChangedListener()	Detach the data changed listener.
void	updateSamsungPay()	An utility function to bring a user to update their Samsung Pay app.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushProvisioning

public PushProvisioning()

Method Detail

getToken

public void getToken(GetTokenInput input,
                     TPCSDKListener<Token> listener)

This method is used to retrieve respective digital token from any of the supported OEM wallets. The method is implemented separately for both Google Pay and Samsung Pay wallets accordingly to handle OEM specific flows.

Possible error returned by this API:

• TPCSDKExceptionType.TPC_SDK_MISSING_PARAM when GetTokenInput.getLast4() last4 is null or empty
• Google Pay:
• TPCSDKExceptionType.TPC_GPAY_UNAVAILABLE
• TPCSDKExceptionType.TPC_GPAY_NO_ACTIVE_WALLET
• TPCSDKExceptionType.TPC_GPAY_INTERNAL_ERROR
• Samsung Pay:
• TPCSDKExceptionType.TPC_SPAY_INVALID_SERVICE_ID
• TPCSDKExceptionType.TPC_SPAY_PARTNER_APP_SIGNATURE_MISMATCH
• TPCSDKExceptionType.TPC_SPAY_PARTNER_APP_VERSION_NOT_SUPPORTED
• TPCSDKExceptionType.TPC_SPAY_INVALID_SERVICE_TYPE
• Huawei Pay:
• Not yet supported
• TPCSDKExceptionType.TPC_UNSUPPORTED_OPERATION

param input GetTokenInput Object that holds mandatory 'last4' parameter, which is the last four numbers of the card(FPAN)

Parameters:

listener - TPCSDKListener The callback used to return Token or

Since:

1.7.0

isCardDigitized

public void isCardDigitized(CardInfo cardInfo,
                            TPCSDKListener<CardDigitizationStatus> listener)

The TPC SDK Api is used to check whether given card is already digitized in any of the supported OEM wallets. The method is implemented separately for both Google Pay and Samsung Pay wallets accordingly to handle OEM specific flow.

Possible error returned by this API:

• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM when CardInfo parameter is null
• Google Pay:
• Any Server or HTTP error in TPCSDKExceptionType when there's connection or operation issue with server
• TPCSDKExceptionType.TPC_GPAY_UNAVAILABLE
• TPCSDKExceptionType.TPC_GPAY_NO_ACTIVE_WALLET
• Samsung Pay:
• Any Server or HTTP error in TPCSDKExceptionType when there's connection or operation issue with server
• TPCSDKExceptionType.TPC_SPAY_INVALID_SERVICE_ID
• TPCSDKExceptionType.TPC_SPAY_PARTNER_APP_SIGNATURE_MISMATCH
• TPCSDKExceptionType.TPC_SPAY_PARTNER_APP_VERSION_NOT_SUPPORTED
• TPCSDKExceptionType.TPC_SPAY_INVALID_SERVICE_TYPE
• Huawei Pay:
• Any Server or HTTP error in TPCSDKExceptionType when there's connection or operation issue with server
• TPCSDKExceptionType.TPC_HPAY_DEVICE_INFO_ERROR

Parameters:

cardInfo - CardInfo Card object holds card info required to check

listener - TPCSDKListener The callback listener used to return the card status or error

addCard

public void addCard(CardInfo cardInfo,
                    TPCSDKListener<T> listener)

This Api helps to add card in selected OEMPayType wallet.

Parameters:

cardInfo - CardInfo Card object holds card info required to do push provision.

listener - TPCSDKListener Generic type parameterized callback to return the respective results.

Possible error returned by this API:

• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM when CardInfo parameter is null.
• Any Server or HTTP error in TPCSDKExceptionType when there's connection or operation issue with server.
• Google Pay:
• TPCSDKExceptionType.TPC_GPAY_MISSING_PARAM
• TPCSDKExceptionType.TPC_GPAY_INTERNAL_ERROR
• TPCSDKExceptionType.TPC_GPAY_UNAVAILABLE
• TPCSDKExceptionType.TPC_GPAY_NO_ACTIVE_WALLET
• TPCSDKExceptionType.TPC_INVALID_CARD_SCHEME
• Samsung Pay:
• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM when Samsung Pay return deviceId or walletId is null or empty
• TPCSDKExceptionType.TPC_SPAY_APP_NOT_FOUND
• TPCSDKExceptionType.TPC_SPAY_APP_NEED_TO_UPDATE
• TPCSDKExceptionType.TPC_SPAY_APP_SETUP_NOT_COMPLETED
• TPCSDKExceptionType.TPC_SPAY_INVALID_SERVICE_ID
• TPCSDKExceptionType.TPC_SPAY_PARTNER_APP_SIGNATURE_MISMATCH
• TPCSDKExceptionType.TPC_SPAY_PARTNER_APP_VERSION_NOT_SUPPORTED
• TPCSDKExceptionType.TPC_SPAY_INVALID_SERVICE_TYPE
• Huawei Pay:
• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM
• TPCSDKExceptionType.TPC_HPAY_DEVICE_INFO_ERROR
• TPCSDKExceptionType.TPC_INVALID_CARD_SCHEME

addCard

public void addCard(Activity activity,
                    CardInfo cardInfo,
                    TPCSDKListener<T> listener)

This Api helps to add card for Google Pay OEMPayType.GOOGLE_PAY wallet. By using this API, TPC SDK initialization does not require Activity.

Parameters:

activity - Activity context.

cardInfo - CardInfo Card object holds card info required to do push provision.

listener - TPCSDKListener Generic type parameterized callback to return the respective results.

Possible error returned by this API:

• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM when CardInfo parameter is null.
• Any Server or HTTP error in TPCSDKExceptionType when there's connection or operation issue with server.
• Google Pay:
• TPCSDKExceptionType.TPC_GPAY_MISSING_PARAM
• TPCSDKExceptionType.TPC_GPAY_INTERNAL_ERROR
• TPCSDKExceptionType.TPC_GPAY_UNAVAILABLE
• TPCSDKExceptionType.TPC_GPAY_NO_ACTIVE_WALLET
• TPCSDKExceptionType.TPC_INVALID_CARD_SCHEME

Since:

1.9.0

addCard

public void addCard(CardInfo cardInfo,
                    String publicKeyId,
                    boolean tcsAccepted,
                    CallbackObject callbackObject,
                    String pushHandler,
                    TPCSDKListener<String> listener)

Deprecated.

Please use new API: TSHProxy.addCard(CardInfo, String, boolean, CallbackObject, String, TPCSDKListener)

This Api helps to add card to selected token requestor which is compatible with issuer card and associated payment scheme. On successful results, the Token requestor URL used for redirection is returned.

Parameters:

cardInfo - CardInfo Card object holds card info required to do push provision.

publicKeyId - Param represents identifier of the key used to encrypt payload.

tcsAccepted - Param value represents whether terms and conditions are accepted by user.

callbackObject - Mandatory param contains callbackObject url and platform type information required by Token Requestor app to pass control back to issuer application.

pushHandler - token requestor push handler is a mandatory field.

listener - TPCSDKListener callbackObject to return the success or failure results.

Possible error returned by this API:

• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM
when encryptedPayload, authorizationCode, deviceId, pushHandler, callback url or callback type is null or empty.
• Any Server or HTTP error in TPCSDKExceptionType when there's connection or operation issue with server

Since:

1.2.0

activateCardWithIdv

public void activateCardWithIdv(CardInfo cardInfo,
                                String tokenReferenceId,
                                TPCSDKListener<CardDigitizationStatus> listener)

This API is to resume ID&V step for those cards with which, digitization is initialized but ID&V step isn't completed. Google Pay only.

Parameters:

cardInfo - BaseRequest.getScheme() & UserDetails.getName() should not be empty.

tokenReferenceId - received from CardDigitizationStatus.getTokenReferenceId().

listener - TPCSDKListener Generic type parameterized callback to return the respective results.

Possible error returned by this API:

• TPCSDKExceptionType.TPC_SERVER_MISSING_PARAM
when cardInfo, name, scheme, or tokenReferenceId is null or empty.
• TPCSDKExceptionType.TPC_GPAY_INTERNAL_ERROR

handleWalletResult

public void handleWalletResult(int requestCode,
                               int resultCode,
                               Intent data)

Handle a callback data that Google Pay is returned to Activity.onActivityResult(int, int, Intent). This function is required to be called during TPCManager.config(Config, TPCSDKListener) and addCard(CardInfo, TPCSDKListener)

Parameters:

requestCode - requestCode available for onActivityResult

resultCode - resultCode available for onActivityResult

data - data available for onActivityResult

Since:

1.2.0

handleWalletResult

public void handleWalletResult(Intent data)

Handle a callback data that Huawei Pay Wallet is returned to Activity.onNewIntent(Intent). This function is required to be called on addCard(CardInfo, TPCSDKListener)

Parameters:

data - data available for onNewIntent

Since:

1.3.11

registerDataChangedListener

public void registerDataChangedListener(TPCSDKDataChangedListener dataChangedListener)

Google Pay Only. The Push Provisioning API will immediately call an issuer app callback whenever the following events occur:

• 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: Registering for these broadcasts allows an issuer app to re-query information about their digitized cards whenever the user makes a change.

Parameters:

dataChangedListener -

Since:

1.2.0

removeDataChangedListener

public void removeDataChangedListener()

Detach the data changed listener. Google Pay Only.

Since:

1.2.0

updateSamsungPay

public void updateSamsungPay()

An utility function to bring a user to update their Samsung Pay app. If the addCard(CardInfo, TPCSDKListener) status is TPCSDKExceptionType.TPC_SPAY_APP_NEED_TO_UPDATE, application can call this API to launch Samsung Pay update page.

activateSamsungPay

public void activateSamsungPay()

An utility function to bring the Samsung Pay app to a state in which cards can be added. Samsung Pay might be either in stub only state or Samsung Account is not signed in state. If the addCard(CardInfo, TPCSDKListener) status is TPCSDKExceptionType.TPC_SPAY_APP_SETUP_NOT_COMPLETED, application can call this API to launch Samsung Pay and user can sign in to the app.