All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AbstractAsyncHandler<T> Abstract class that is used throughout the SDK to handle the result of an asynchronous operation.AbstractHCEService Abstract class for the HCE service.AbstractWalletPinService This class is mainly used to setup a Wallet PIN service which the MPA needs to implement.AccessTokenListener This interface will allow the mobile wallet to get the state of the get access token process.Address Address indicates the detail address information of the WalletAccountData.Aid This interface represents the Application Identifier stored in PPSE FCI.Aid.LockStatus The enum class for Aid lock status.AndroidContextResolver This utility class provides access to the application context.APDUProcessorSetupCallbacks This interface contain callback methods used for APDUs processing.AppToAppData A data class to be used inPendingCardActivation.getAppToAppData()
It will provide MPA data to launch issuer applicationAsyncHCEService Abstract class for the HCE service.AsyncResult<T> The result object that will be returned by all operations in this SDK.AsyncToken<T> Token that manages waiting for an asynchronous operation to finish.AuthenticationState This class represents the state of authentication.AuthenticationState.AuthState The enum class for authentication states.AuthenticationStateListener Listener to handle callbacks while checking Authentication is needed or not.AuthMethod BiometricsSupport An enum that identified if the device is capable of supporting the biometrics or not.BusinessService This interface contains the BusinessService Methods used to initialize and reset the SDK with different Modules of the SDK namely: 1.CardActivationListener CardArt CardArt provides the Card information used by the MPA for display.CardArtSize CardArtSize provides size information of the Card arts.CardArtType CardArtType indicates the different types of the card art.CardBitmap CardBitmap provides the size and bitmap resource of the card art.CardEligibilityListener Listener to return the response for the check card eligibility request.CardListFetchListener CardMetaData Contains meta data for digital card.CardMetaDataFetchListener Created by rsriniva on 18/6/2018.CardProduct CardProduct provides the information of a particular card product.CardScheme Card Scheme supported for the TransactionCardStatus CdcvmSupported An enum that identifies if the Terminal supports cdcvmCHCodeVerifier CHMobilePin verification interfaceCHCodeVerifierErrorCode The error code enum class for CHCodeVerifier.CHCodeVerifierListener A listener that may be called by the SDK depending on the supported CVM (e.g.CHVerificationManager A singleton factory class that acts as a manager of the card holder verification method.CHVerificationMethod Enumeration of possible CardHolder verification method that may be required when activating a digitalized card for transaction.
Following is the mapping for the different CVM and type of verifier object.CHVerificationResult<T> The synchronised result object that will be returned by all operations inCHVerificationManager
.ContactlessPaymentServiceListener Listener for the contactless payment transaction.ContextResolverInterface This interface provides the API to get the ContextResolver.CPSCommService This class extends AndroidJobIntentService
and it acts as the common CPS service which is started in foreground.CPSKeyStoreException An Exception is thrown if there are any error encountered during KeyStore.CryptogramDataType CustomApduListener This interface contains the APDu Listener.CustomConfiguration This is a helper class used for providing custom build parameters used for SDK.CustomConfiguration.Builder CustomRAPDUHeaderByte Known response APDU header bytes between the Plugin SDK and HCE SDK for the processingCVMResetTimeoutListener Interface to receive the count down event after the CardHolder verification input has been entered.CVMType This class represents list of CVM Types which used by MPADataPreparationListener This interface will allow the mobile wallet to get the state of the Vas Provisioning process.DataPreparationResponse Response Object for VAS provisioningDate DCMBroadcastService Deprecated. since 6.8.0DCMErrorCodes DCMErrorMessage DeactivationStatus This class provides deactivation status code and details message of the deactivation process.DeactivationStatusCode This class represents Deactivation Status Codes.DeviceCVMCancellationSignal Provides the ability to cancel a biometric authentication operation in progress.DeviceCVMEligibilityChecker This is responsible for checking if the Device Keyguard and Biometric Fingerprint is supported by the current device and whether everything is in place in the device to use them as a CD-CVM method.DeviceCVMEligibilityResult This class holds the support results for Device keyguard and Biometric Fingerprint of the current device.DeviceCVMException An exception thrown if there are error encountered while performing biometric fingerprint operation.DeviceCVMKeyguardActivity A class that manages the Device keyguard mechanism whenCHVerificationMethod
isDEVICE_KEYGUARD
.DeviceCVMManager This class is used in line with the support of Biometric Fingerprint and Device keyguard as CHVerificationMethod.DeviceCVMPreEntryReceiver This receiver is activated when the user unlock his deviceDeviceCVMPreEntryService DeviceCVMPreEntryService that start the DeviceCVMPreEntryReceiver.DeviceCVMVerifier Device CVM (Biofingerprint or device keyguard) verification interface.DeviceCVMVerifierInput A class that contains information used for starting biometric authentication.DeviceCVMVerifyAdditionalErrors DeviceCVMVerifyListener This interface is "called" by the SDK in order to inform the MPA for the biometric fingerprint/Device keyguard authentication status.DeviceKeyguardSupport An enum that identified if the device is capable of supporting the device keyguard as CHVerificationMethod.DigitalizedCard Interface describing the digitalized card.DigitalizedCardAdditionalPaymentData This class used to set the additional Payment Data present in the Digital Card Profile.DigitalizedCardDetails Interface that will be used to retrieve details about the card that has been provisioned.DigitalizedCardErrorCodes Error codes used when a problem is encountered when performing operations with the DCMDigitalizedCardManager This serves as the entry point to the Digitalized Card Manager Module.DigitalizedCardProfileKeys This contains a list of keys for insensitive and custom data in the card profile that can be retrieved by the UI application, via APIDigitalizedCardDetails.getValue(String)
.DigitalizedCardState This class contains the list of possible card states.DigitalizedCardStatus This interface defines the current state of the Digitalized Card.DSRPConstants EligibilityData The Eligibility Data is used by MPA for CheckEligibility.EligibilityData.Builder Builder to build EligibilityData.EnrollingBusinessService This service is responsible for enrolling the end-user to both the ASM and the CPS.EnrollingServiceListener This interface will allow the mobile wallet to understand the current stage of the enrollment process.EnrollmentStatus Enumeration indicating the different enrollment statuses or states of the SDK.ExistingRetrySessionException This is the exception class that represents the exceptions for existing retry sessions.GetAccessTokenMode This contains a list of available mode to get access tokenProvisioningBusinessService.getAccessToken(String, GetAccessTokenMode, AccessTokenListener)
.IDVMethod IDVMethod supported by the Card Enrollment.IDVMethodSelector IDVMethodSelector provides a way to select different IDVMethods supported for the Card Activation.InputMethod InputMethod indicates the mode of card details entry.InstrumentData The Instrument Data is used by MPA for CheckEligibility.InstrumentData.EncryptedCardDataBuilder EncryptedCardDataBuilder to buildInstrumentData
.InstrumentData.IssuerPushReceiptBuilder IssuerPushReceiptBuilder to build InstrumentData.InstrumentDataType InternalComponentException An Exception class to handle Error occurred in internal Component or during the migration of the SDK Version.IssuerData IssuerData indicates the information of the issuer.IssuerPushReceipt The IssuerPushReceipt is used by MPA for CheckEligibility.KeyValues Key values indicates the information to be update to the serverKnownCpsErrorCodes The list of known status reasons from server response.
The list does NOT include the "System Error" from server, which includes 670 to 679.
DISCLAIMER: The list is for reference purpose.KnownMessageCode List of known message codes that are sent in a message from server.
Constants with "REQUEST" prefix are sent in every server push that updates the card database on the device, to convey the operation to the UI application.MasterCardTerminalInfo This interface contains the terminal Information for Master Card.MasterCardTransactionContext This interface contains the value of Transaction Context Specifically for MasterCard.MasterCardTransactionInfo This interface contains the Transaction Info specific for MasterCard.MerchantIdentifier MessageClassification Different type of messagesMGAbstractAsyncHandler<T> MGAbstractAsyncHandler class extends the Android OS Handler and is responsible for posting the messages to the UI thread after a MG SDK task in complete.MGAsyncResult<T> MGAsyncResult provides the result of the task that was posted by the MGAbstractAsyncHandler.MGCardEnrollmentService The card enrollment service is responsible for card digitization process.MGCardInfoEncryptor A utility class to encrypt the Contactless Card Information using the public key embedded in the MG SDK.MGCardLifecycleEventListener Listener to the card lifecycle events like SUSPEND, RESUME, DELETE, and UPDATE card.MGCardLifeCycleManager The card life cycle manager component as what the name suggests manages the life cycle (e.g.MGCardLiteEntry Represents an entry of a particular card managed by the MG SDK.MGCardManager A supplementary public interface providing convenient methodsMGConfiguration Super Interface for Mobile Gateway ConfigurationsMGConfigurationChangeReceiver Deprecated. since 6.6.0MGConfigurationChangeService Deprecated. since 6.6.0.MGConfigurationException This Class indicates the exception occurred due to a invalid configuration.MGConfigurationResetListener This Listener class is used to return the status of configuration reset of SDK.MGConnectionConfiguration Class for Mobile Gateway Connection configurationMGConnectionConfiguration.Builder Builder to build MGConnectionConfiguration.MGDigitizationListener Listener for the digitize card events.MGErrorCode MGErrorCode provides the different kinds of error returned by the Mobile Gateway library.MGException This Class indicates a Generic Exception thrown from the Mobile Gateway SDK that is expected to be caughtMGRuntimeException Deprecated. since 6.6MGSDKConfigurationState This class encapsulates all the different configuration states that SDK can be in.MGSDKException Deprecated. since SDK 6.6.MGStorageConfigurationException This exception class indicates the exception occurred due to issue accessing internal storage of MGSDK during configuration.MGTransactionHistoryConfiguration Builder class of MG Transaction Configuration to save URLMGTransactionHistoryConfiguration.Builder Builder to build MGTransactionHistoryConfiguration.MGTransactionHistoryService MGTransactionHistoryService provides API to request transaction history performed on provided card Same API can be used for Transaction Notification as MPA need to pass digitalCardId and timestamp received from push notification to query for notification detailMGTransactionRecord Interface containing data related to any transactionMGWalletConfiguration Class for Mobile Gateway Wallet configurationMGWalletConfiguration.Builder Builder to build MGWalletConfiguration.MobileGatewayError The MobileGatewayError provides the details of the error occurred during a card operation.MobileGatewayManager The mobile gateway manager in the main entry point of the MG SDK.NeedsAuthenticationErrorCode The error code enum class for case of needing authentication.NoSessionException This is the exception class that represents the exceptions for no sessions.NoSuchCardException This Class indicates a an Exception thrown from the Mobile Gateway if a card is not foundOutcome High level summary of what has happened in the transaction.PaymentBusinessManager This serves as the entry point to the Payment Business Module.PaymentBusinessService Initiates the Payment business service to perform payment related commands.PaymentExperience PaymentExperience
enum class gives the information to the MPA whether the device is capable of performing one tap or two taps payment experiencePaymentExperienceSettings This class gives MPA the possibility to get the supported payment experience and set the expected payment experience in case the contactless payment flow is initiated whereas the TSHPaySDK is not initialized beforehand.PaymentInputData This Class provides API to build input parameters for the Transaction payment using builderPaymentInputData.PaymentInputBuilder PaymentService PaymentService
is an engine that enables the flow and contains execution information for a payment transaction.PaymentServiceErrorCode Error codes for Payment Service operations to indicate an error that happened.PaymentServiceListener Common listener for the payment transaction.PaymentServiceMessageCode This class includes payment service message codes.PaymentSettings This class contains the Payment Settings public APIs.PaymentType This class contains the list of all supported payment types.PendingCardActivation PendingCardActivation indicates the card which are previously interrupted during activation.PendingCardActivationState PendingCardActivationState indicate the constants for the state of the Pending card activation.PluginRegistrationManager This enum contains the plugin registration methods.ProductListener Listener for the get card product list events.ProfileChannel This enum is use to analyse what payment is supported for a card and returns byte code for each profile Type.ProfileUpdatablePaths The supported list of card profile paths that allow update for the transaction.ProfileUpdatablePaths.Mastercard Supported paths for Mastercard scheme.ProfileUpdatablePaths.Visa Supported paths for Visa scheme.ProvisioningBusinessService This service is responsible to communicate to CPS and entertain the requests received from CPS via push notifications.ProvisioningServiceCodeType During the enrollment or card activation phase, the end user is able to enter the following codes: The activation code The mobile PIN This will be the enumeration of the type of verification required.ProvisioningServiceError Errors pertaining to provisioning may have different causes.ProvisioningServiceErrorCodes Error codes for Provisioning Service operations to indicate an error that happened.ProvisioningServiceManager This class provides the functionalities to build the connection between SDK & CPS, handles incoming message from CPS and takes an action inside SDK accordingly.ProvisioningServiceMessage It contains the data received from CPS for provisioning serviceProvisioningServicePinType Enumeration of the possible pin types that the user is may send to the CPS together with the activation code.PushServiceListener Listener to handle callbacks related to push notifications.QRCodeData Object that hold all the data necessary to generate a QR Code symbol for a payment.QRCodePaymentServiceListener Listener for the QR code payment transaction.RemotePaymentOutputData RemotePaymentServiceListener Listener for the Remote payment payment transaction.ReplenishmentPrepListener This class is the callback during replenishment preparation time with MPA MPA will implement this class.ReplenishmentPrepService This interface contains the method Replenishment preparation.ReplenishmentPrepStatus SDKController The entry point to the configure the SDK.SDKControllerListener This interface contains callback used during the SDK initialization or Setup.SDKDataController This enum contains the public API for wipeAll of the card Details.SDKEnv Contains build-time environment variables.SDKEnv Contains build-time environment variables.SDKError<T> This interface contains callback used when the SDK throws the Error.SDKInitializationException SDKInitializeErrorCode This enum contains the list of the ErrorCode of SDK initialize.SDKInitializer This enum contains the public APIs for initializing the SDK before starting the payment.SDKServiceState Gives the state of initialization of CPS SDK.SDKSetupProgressState Gives Progress state during SDK initialization process.SecureCodeInputer Secure pin inputer interfaceSecureLogConstants Default configuration to be used for SecureLogServiceAlreadyActivatedException This SDKRuntimeException will be thrown when an activated service is being activated again.TerminalTechnology The type of technology supported by the Terminal, It is the type of transaction requested by the terminal.TerminalType The type of the TerminalTermsAndConditions TermsAndConditions provides the Contents of the Terms and Condition and also provides the means to accept it.TermsAndConditionSession TermsAndConditionSession is a marker interface which is returned after accepting the Terms and Condition.TermsAndConditionsListener Listener for the getTermsAndConditions events.ThreeDSecure IDVMethod supported by the Card Enrollment.TokenSyncError TokenSyncError provides the details of the error occurred during token sync process.TokenSyncErrorCode This class represents Token Sync Error Codes.TokenSyncListener An interface to delegate events while processing token sync use case.TokenSyncStatus This class represents Token Sync Status Codes.TransactionConditions This defines if the Transaction is Domestic or InternationalTransactionContext It contains the different value of the current transaction.TransactionHistoryListener Listener to return the transactionHistory for provided digitalCardIdTransactionPurpose This defines the Purpose of the TransactionTransactionRange This defines the Range of the TransactionTransactionStatus Status of the transactionTransactionType TransactionType Represent the richTransactionType for MCBP2.1.TwoTapSupported This defines if 2 taps is supported for the TransactionUserActionOnPoi Value containing the Expected User Action on Point of InteractionValidityPeriod ValidityPeriod indicates the validity period as a part of the information that exists in the CardProduct.VasProvisioningBusinessService This service is responsible to communicate to CPS to support Provisioning for VAS.VisaConstants This interface contains VisaConstants used while replenishment.WalletAccountData The WalletAccountData are used by MPA for CheckCardEligibility.WalletPinErrorCode An enum of the list of error codes related to specific use case for wallet PIN management.WalletPinEventListener An interface to delegate events while managing the wallet PIN use cases.WalletPinException An exception raised whenever performing an operation related to wallet pin while it is not set previously.WalletPinManager A class to manage the wallet pin use case (e.g.WalletSecureEnrollmentBusinessService This service is responsible to manage and communicate with CPS to support renewal from a diversifier version to an other.WalletSecureEnrollmentError Errors pertaining to renewing may have different causes.WalletSecureEnrollmentErrorCodes This class represents the errors occurred during performing wallet secure enrollment.WalletSecureEnrollmentException Errors pertaining to renewing may have different causes.WalletSecureEnrollmentListener An interface to delegate events while managing the wallet secure enrollment use case.WalletSecureEnrollmentState Enumeration indicating the different renewal states of the SDK.