All Classes and Interfaces
Class
Description
Abstract class that is used throughout the SDK to handle the result of an
asynchronous operation.
Abstract class for the HCE service.
This class is mainly used to set up a wallet PIN service which MPA needs to implement.
This interface will allow the mobile wallet to get the
state of the get access token process.
Address indicates the detail address information of the WalletAccountData.
This interface represents the application identifier that is stored in PPSE FCI.
The enum class for AID lock status.
This utility class provides access to the application context.
This interface contain callback methods used for APDUs processing.
A data class to be used in
PendingCardActivation.getAppToAppData().Abstract class for the HCE service.
The result object that will be returned by all operations in this SDK.
Token that manages waiting for an asynchronous operation to finish.
This class represents the state of authentication.
The enum class for authentication states.
Listener to handle callbacks while checking Authentication is needed or not.
An enum that identifies if the device is capable of supporting the biometrics.
This interface contains the BusinessService Methods used to initialize and reset the SDK with different Modules of the SDK namely:
1.
CardArt provides the card information used by MPA for display.
CardArtSize provides the size information of the card art.
CardArtType indicates the different types of card arts that are available.
CardBitmap provides the size and bitmap resource of the card art.
The
CardEligibilityListener class is used to return the response for the check card eligibility request.Contains the meta data of the digital card.
The
CardMetaDataFetchListener class is used to return the response for the getCardMetaData request.CardProduct provides the information of a particular card.
Card Scheme supported for the Transaction
An enum that identifies if the Terminal supports cdcvm
CHMobilePin verification interface
The error code enum class for CHCodeVerifier.
A listener that may be called by the SDK depending on the supported CVM (e.g.
A singleton factory class that acts as a manager of the card holder verification method.
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.
Following is the mapping for the different CVM and type of verifier object.
The synchronised result object that will be returned by all operations in
CHVerificationManager.Listener for the contactless payment transaction.
This interface provides the API to get the ContextResolver.
This class extends Android
JobIntentService and it acts as the common CPS service which is
started in foreground.An exception is thrown when errors are encountered during keystore creation.
This interface contains the APDu Listener.
This is a helper class used for providing custom build parameters used for SDK.
Known response APDU header bytes between the Plugin SDK and HCE SDK for the processing
Interface to receive the count down event after the CardHolder verification
input has been entered.
This class represents list of CVM Types which used by MPA
This interface will allow the mobile wallet to get the
state of the Vas Provisioning process.
Response Object for VAS provisioning
Deprecated.
since 6.8.0
This class provides deactivation status code and details message of the deactivation process.
This class represents Deactivation Status Codes.
Provides the ability to cancel a biometric authentication operation that is in progress.
To check if the device keyguard and biometric fingerprint are supported by the current device and
that everything is in place in the device to use them as a CDCVM method.
This class holds the support results for device keyguard and biometric fingerprint of the current device.
An exception is thrown when errors are encountered while performing the biometric fingerprint operation.
A class that manages the device keyguard mechanism when
CHVerificationMethod is
DEVICE_KEYGUARD.The CHVerificationMethod class is used to support the use of biometric fingerprint and device keyguard.
This receiver is activated when the user unlock his device
DeviceCVMPreEntryService that start the DeviceCVMPreEntryReceiver.
Device CVM (biometric fingerprint or device keyguard) verification interface.
A class that contains information used for starting biometric authentication.
The
DeviceCVMVerifyAdditionalErrors class defines additional set of error codes used
when a problem is encountered during Device CVM verification.This interface is "called" by the SDK in order to inform the MPA for the biometric fingerprint/Device keyguard
authentication status.
An enum that identifies if the device is capable of supporting the device keyguard as CHVerificationMethod.
Interface describing the digitalized card.
This class is used to set the additional Payment Data that is present in the Digital Card Profile.
This is an interface that will be used to retrieve the card details that has been
provisioned.
The
DigitalizedCardErrorCodes class defines a set of error codes used
when a problem is encountered during DCM operations.This serves as the entry point to the Digitalized Card Manager Module.
This contains a list of keys for non-sensitive and custom data in the card
profile that can be retrieved by the UI application via the
DigitalizedCardDetails.getValue(String) API.This class contains the list of possible card states.
This interface defines the current state of the digitalized card.
EligibilityData is used by MPA for CheckEligibility.
Builder to build EligibilityData.
This service is responsible for enrolling the end-user to both the ASM and
the CPS.
This interface will allow the mobile wallet to understand the current stage
of the enrollment process.
Enumeration indicating the different enrollment statuses or states of the
SDK.
This is the exception class that represents the exceptions for existing retry sessions.
This contains a list of available mode to get access token
ProvisioningBusinessService.getAccessToken(String, GetAccessTokenMode, AccessTokenListener).IDVMethod is supported by the card enrollment process.
IDVMethodSelector provides a way to select different IDVMethods supported for card activation.
InputMethod indicates the entry method for card details.
InstrumentData is used by MPA for CheckEligibility.
EncryptedCardDataBuilder to build
InstrumentData.IssuerPushReceiptBuilder to build InstrumentData.
This Exception class handles the errors that occurred in the internal components or during a migration of the SDK Version.
IssuerData indicates the information of the issuer.
IssuerPushReceipt is used by MPA for CheckEligibility.
The key values indicates the information to be updated to the server.
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.
The list does NOT include the "System Error" from server, which includes 670 to 679.
DISCLAIMER: The list is for reference purpose.
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.
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.
This interface contains the terminal Information for Master Card.
This interface contains the value of Transaction Context Specifically for MasterCard.
This interface contains the Transaction Info specific for MasterCard.
Different type of messages
MGAbstractAsyncHandler class extends the Android OS Handler and is responsible for posting the messages to the UI thread after a MG SDK task is completed.
MGAsyncResult provides the result of the task that is posted by MGAbstractAsyncHandler.
The card enrollment service is responsible for card digitization process.
A utility class to encrypt the contactless card information using the public key embedded in MG SDK.
The
MGCardLifecycleEventListener class is used as a listener of the card life cycle events such as SUSPEND, RESUME, DELETE, and UPDATE card.The card life cycle manager component as what the name suggests manages the life cycle (e.g.
Represents an entry of a particular card managed by the MG SDK.
A supplementary public interface providing convenient methods
Super Interface for Mobile Gateway Configurations
Deprecated.
since 6.6.0
Deprecated.
since 6.6.0.
This class indicates the exception that occurs due to an invalid configuration.
The
MGConfigurationResetListener class is used to return the status of the SDK configuration reset.Class for Mobile Gateway Connection configuration
Builder to build MGConnectionConfiguration.
The
MGDigitizationListener class is used for digitize card events.MGErrorCode provides the different types of errors that are returned by the Mobile Gateway library.
This class indicates a generic exception that is thrown by Mobile Gateway SDK that is expected to be caught.
Deprecated.
since 6.6
This class encapsulates all the different configuration states that SDK can be in.
Deprecated.
since SDK 6.6.
This class indicates the exception that occurs when cannot access the internal storage of MGSDK during its configuration.
Builder class of MG Transaction Configuration to save URL
Builder to build MGTransactionHistoryConfiguration.
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 detail
Interface containing data related to any transaction
Class for Mobile Gateway Wallet configuration
Builder to build MGWalletConfiguration.
The MobileGatewayError provides the details of the error occurred during a card operation.
The mobile gateway manager in the main entry point of the MG SDK.
The error code enum class for case of needing authentication.
This is the exception class that represents the exceptions for no sessions.
This class indicates an exception that is thrown by Mobile Gateway when a card is not found.
High level summary of what has happened in the transaction.
This serves as the entry point to the Payment Business Module.
Initiates the Payment business service to perform payment related commands.
PaymentExperience enum class gives the information to the MPA whether the device is capable of performing one tap or two taps payment experienceThis 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.
This Class provides API to build input parameters for the Transaction payment using builder
PaymentService is an engine that enables the flow and contains
execution information for a payment transaction.Error codes for Payment Service operations to indicate an error that
happened.
Common listener for the payment transaction.
This class includes payment service message codes.
This class contains the Payment Settings public APIs.
This class contains the list of all supported payment types.
The PendingCardActivation interface indicates the cards which are previously interrupted during the activation.
PendingCardActivationState indicates the constants for the state of the cards that are pending for activation
This enum contains the plugin registration methods.
The
ProductListener class is used to get card product list events.This enum is used to analyse the type of payment supported by a card and return byte codes for each profile.
The supported list of card profile paths that allow update for the transaction.
Supported paths for Mastercard scheme.
Supported paths for Visa scheme.
This service is responsible to communicate to CPS and entertain the requests
received from CPS via push notifications.
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.
Errors pertaining to provisioning may have different causes.
Error codes for Provisioning Service operations to indicate an error that
happened.
This class provides the functionalities to build the connection between SDK &
CPS, handles incoming message from CPS and takes an action inside SDK
accordingly.
It contains the data received from CPS for provisioning service
Enumeration of the possible pin types that the user is may send to the CPS
together with the activation code.
Listener to handle callbacks related to push notifications.
Object that hold all the data necessary to generate a QR Code symbol for a payment.
Listener for the QR code payment transaction.
Listener for the Remote payment payment transaction.
This class is the callback during replenishment preparation time with MPA
MPA will implement this class.
This interface contains the method Replenishment preparation.
The entry point to the configure the SDK.
This interface contains callback used during the SDK initialization or Setup.
This enum contains the public API for wipeAll of the card Details.
Contains build-time environment variables.
Contains build-time environment variables.
This interface contains callback used when the SDK throws the Error.
This enum contains the list of the ErrorCode of SDK initialize.
This enum contains the public APIs for initializing the SDK before starting the payment.
Gives the state of initialization of CPS SDK.
Gives Progress state during SDK initialization process.
Secure pin inputer interface
Default configuration to be used for SecureLog
This SDKRuntimeException will be thrown when an activated service is being
activated again.
The type of technology supported by the Terminal, It is the type of transaction requested by the terminal.
The type of the Terminal
TermsAndConditions provides the agreement on the rules for using the SDK, and requires the end user to agree and accept it.
TermsAndConditionSession is a marker interface which is returned after the end user accepts the terms and conditions agreement.
The
TermsAndConditionsListener class is used for the getTermsAndConditions events.IDVMethod supported by the card enrolment.
TokenSyncError provides the details of the error that occurs during the token synchronisation process.
The
TokenSyncErrorCode class defines a set of error codes used
when a problem is encountered during token synchronisation process.An interface to delegate events while processing token sync use case.
The
TokenSyncStatus class contains the status codes of the token synchronisation processThis defines if the Transaction is Domestic or International
Contains the different values of the current transaction.
The
TransactionHistoryListener class is used to return the transactionHistory for the digitalCardId provided.This defines the Purpose of the Transaction
This defines the Range of the Transaction
Status of the transaction.
Represent the richTransactionType for MCBP2.1.
This defines if 2 taps is supported for the Transaction
Value containing the Expected User Action on Point of Interaction
ValidityPeriod indicates the validity period of the card that exists in CardProduct.
This service is responsible to communicate to CPS to
support Provisioning for VAS.
This interface contains VisaConstants used while replenishment.
WalletAccountData is used by MPA for CheckCardEligibility.
An enum containing the list of error codes related to a specific use case for wallet PIN management.
An interface to delegate events while managing the wallet PIN use cases.
An exception is raised whenever an operation related to wallet PIN is performed without setting it.
A class to manage the wallet PIN use case (for example, set, change or verify the PIN).
This service is responsible to manage and communicate with CPS to
support renewal from a diversifier version to an other.
Errors pertaining to renewing may have different causes.
This class represents the errors occurred during performing wallet secure enrollment.
Errors pertaining to renewing may have different causes.
An interface to delegate events while managing the wallet secure enrollment use case.
Enumeration indicating the different renewal states of the
SDK.