Package com.meawallet.mpp
Class MeaPushProvisioning
java.lang.Object
com.meawallet.mpp.MeaPushProvisioning
Provides API for interaction with the MeaPushProvisioning library using static methods.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
MeaPushProvisioning library configuration information.static class
Methods which can be used to simplify Google Pay Push Provisioning flow.static class
Methods which can be used to simplify Issuer Pay Push Provisioning flow.static class
Methods which can be used to simplify Samsung Pay Push Provisioning flow. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic MppGetTokensResponseData
check
(String tokenRequestorId, MppCardDataParameters cardData) Checks if specified card is added to selected Token Requestor.static void
check
(String tokenRequestorId, MppCardDataParameters cardData, MppGetTokensListener listener) Checks if specified card is added to selected Token Requestor.static void
delete()
Deletes all the local data of MPP SDK and turns it into an uninitialized state.static MppPushResponseData
deleteCard
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId, MppCardDataParameters cardParams, String externalCardId) Deletes card (payment instrument) information from consumer profile.static void
deleteCard
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId, MppCardDataParameters cardParams, String externalCardId, MppPushResponseDataListener listener) Deletes card (payment instrument) information from consumer profile.static MppPushResponseData
deleteCard
(String tokenRequestorId, String externalConsumerId, MppCardDataParameters cardParams) Deprecated.static void
deleteCard
(String tokenRequestorId, String externalConsumerId, MppCardDataParameters cardParams, MppPushListener listener) static MppPushResponseData
deleteConsumer
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId) Deletes consumer information and all cards (payment instruments) related to the profile.static void
deleteConsumer
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId, MppPushResponseDataListener listener) Deletes consumer information and all cards (payment instruments) related to the profile.static MppPushResponseData
deleteConsumer
(String tokenRequestorId, String externalConsumerId) Deprecated.UsedeleteConsumer(String, MppPaymentNetwork, String)
instead.static void
deleteConsumer
(String tokenRequestorId, String externalConsumerId, MppPushListener listener) Deprecated.Gets static Assets from MDESs repository, such as: Card art, Mastercard brand logos, Issuers logos, Terms and Conditions.static void
getAsset
(String assetId, MppGetAssetListener listener) Gets static Assets from MDESs repository, such as: Card art, Mastercard brand logos, Issuers logos, Terms and Conditions.static MppConsumerDetails
getConsumerDetails
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId) Retrieves consumer and cards (payment instrument) information.static void
getConsumerDetails
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId, MppConsumerDetailsListener listener) Retrieves consumer and cards (payment instrument) information.static MppConsumerDetails
getConsumerDetails
(String tokenRequestorId, String externalConsumerId) Deprecated.static void
getConsumerDetails
(String tokenRequestorId, String externalConsumerId, MppConsumerDetailsListener listener) Deprecated.static MppConsumerRequestStatus
getConsumerRequestStatus
(String tokenRequestorId, String requestTraceId) Retrieves consumer request status.static void
getConsumerRequestStatus
(String tokenRequestorId, String requestTraceId, MppConsumerStatusListener listener) Retrieves consumer request status.static List<MppTokenRequestor>
Retrieves eligible Token Requestors which support push provisioning for provided account ranges.static void
getEligibleTokenRequestors
(MppCardDataParameters cardData, MppGetTokenRequestorsListener listener) Retrieves eligible Token Requestors which support push provisioning for provided account ranges.static List<MppTokenRequestor>
getEligibleTokenRequestorsForAccountRanges
(List<String> accountRanges) Retrieves eligible Token Requestors which support push provisioning for provided account ranges.static void
getEligibleTokenRequestorsForAccountRanges
(List<String> accountRanges, MppGetTokenRequestorsListener listener) Retrieves eligible Token Requestors which support push provisioning for provided account ranges.static List<MppTokenRequestor>
Retrieves eligible Token Requestors which support push provisioning for provided cards.static void
getEligibleTokenRequestorsForCards
(List<MppCardDataParameters> cards, MppGetTokenRequestorsListener listener) Retrieves eligible Token Requestors which support push provisioning for provided cards.getGooglePayTokenizationData
(MppCardDataParameters cardData, String walletId, String deviceId, Context context) Deprecated.static void
getGooglePayTokenizationData
(MppCardDataParameters cardData, String walletId, String deviceId, Context context, MppGetOemTokenizationDataListener listener) Deprecated.static MppGetTokensResponseData
getGooglePayTokens
(MppCardDataParameters cardData, String walletId, String deviceId, Context context) Deprecated.static void
getGooglePayTokens
(MppCardDataParameters cardData, String walletId, String deviceId, Context context, MppGetTokensListener listener) Deprecated.getSamsungPayTokenizationData
(MppCardDataParameters cardData, String walletId, String deviceId, Context context) Deprecated.static void
getSamsungPayTokenizationData
(MppCardDataParameters cardData, String walletId, String deviceId, Context context, MppGetOemTokenizationDataListener listener) Deprecated.static MppGetTokensResponseData
getSamsungPayTokens
(MppCardDataParameters cardData, String walletId, String deviceId, Context context) Deprecated.static void
getSamsungPayTokens
(MppCardDataParameters cardData, String walletId, String deviceId, Context context, MppGetTokensListener listener) Deprecated.getTokenizationReceipt
(String tokenRequestorId, MppCardDataParameters cardData, Context context) Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned bygetEligibleTokenRequestors(MppCardDataParameters)
method.static void
getTokenizationReceipt
(String tokenRequestorId, MppCardDataParameters cardData, Context context, MppGetTokenizationReceiptListener listener) Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned by #getEligibleTokenRequestors(MppCardDataParameters)} method.getTokenizationReceipt
(String tokenRequestorId, MppCardDataParameters cardData, MppIntent intent, Context context) Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned by #getEligibleTokenRequestors(MppCardDataParameters)} method.static void
getTokenizationReceipt
(String tokenRequestorId, MppCardDataParameters cardData, MppIntent intent, Context context, MppGetTokenizationReceiptListener listener) Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned by {#getEligibleTokenRequestors(MppCardDataParameters)} method.static String
getTokenUniqueReference
(Intent intent) Gets Token Unique Reference from Intent payload.static void
initialize
(Context context) Initializes the MeaPushProvisioning library.static void
initialize
(Context context, String configFileName) Initializes the MeaPushProvisioning library.static boolean
Indicates whether the MeaPushProvisioning library has been initialized.static MppPushResponseData
push
(String tokenRequestorId, MppCardDataParameters cardParams, MppConsumerInformation consumerInformation, MppBillingAddress billingAddress) Pushes (enroll) specified card to selected Token Requestor / Click to Pay.static void
push
(String tokenRequestorId, MppCardDataParameters cardParams, MppConsumerInformation consumerInformation, MppBillingAddress billingAddress, MppPushListener listener) static void
push
(String tokenRequestorId, MppCardDataParameters cardParams, MppConsumerInformation consumerInformation, MppBillingAddress billingAddress, MppPushResponseDataListener listener) Pushes (enroll) specified card to selected Token Requestor / Click to Pay.static void
sendUserToTokenRequestor
(Activity activity, String applicationUri, String webUri, String pushAccountReceiptParameter, String callbackUrlParameter, Boolean completeIssuerAppActivationParameter, Boolean completeWebsiteActivationParameter) Helper method to start the Token Requestor Application activity if it's safe, else the Browser activity, using URI data obtained fromgetTokenizationReceipt(String, MppCardDataParameters, Context)
.static MppPushResponseData
updateCardDetails
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId, MppCardDataParameters cardParams, String cardholderName, String expiryYear, String expiryMonth, MppBillingAddress billingAddress, String externalCardId) Updates card details.static void
updateCardDetails
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, String externalConsumerId, MppCardDataParameters cardParams, String cardholderName, String expiryYear, String expiryMonth, MppBillingAddress billingAddress, String externalCardId, MppPushResponseDataListener listener) Updates card details.static MppPushResponseData
updateCardDetails
(String tokenRequestorId, String externalConsumerId, MppCardDataParameters cardParams, String cardholderName, String expiryYear, String expiryMonth, MppBillingAddress billingAddress) static void
updateCardDetails
(String tokenRequestorId, String externalConsumerId, MppCardDataParameters cardParams, String cardholderName, String expiryYear, String expiryMonth, MppBillingAddress billingAddress, MppPushListener listener) static MppPushResponseData
updateConsumerDetails
(String tokenRequestorId, MppConsumerInformation consumerInformation) Deprecated.static void
updateConsumerDetails
(String tokenRequestorId, MppConsumerInformation consumerInformation, MppPushListener listener) static MppPushResponseData
updateConsumerDetails
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, MppConsumerInformation consumerInformation) Updates the consumer information such as customer name, email, or phone number.static void
updateConsumerDetails
(String tokenRequestorId, MppPaymentNetwork paymentNetwork, MppConsumerInformation consumerInformation, MppPushResponseDataListener listener) Updates the consumer information such as customer name, email, or phone number.
-
Field Details
-
ClickToPay
-
-
Method Details
-
initialize
Initializes the MeaPushProvisioning library. It is required to call this method before interacting with any other of the MeaPushProvisioning API's.- Parameters:
context
- The Application Context.- Throws:
MppException
- if the library initialization fails. UseMppException.getMppError()
()} to get error object with error code and error description.
-
initialize
Initializes the MeaPushProvisioning library. It is required to call this method before interacting with any other of the MeaPushProvisioning API's.- Parameters:
context
- The Application Context.configFileName
- file name in the `raw` folder or path to file on the Application's private internal storage.- Throws:
MppException
- if the library initialization fails. UseMppException.getMppError()
()} to get error object with error code and error description.
-
isInitialized
public static boolean isInitialized()Indicates whether the MeaPushProvisioning library has been initialized.- Returns:
- true if initialized, false if not initialized.
-
getEligibleTokenRequestorsForAccountRanges
@WorkerThread public static List<MppTokenRequestor> getEligibleTokenRequestorsForAccountRanges(@NonNull List<String> accountRanges) throws MppException, NetworkOnMainThreadException Retrieves eligible Token Requestors which support push provisioning for provided account ranges. Once the list of requestors is received, user has an option to select the one to be used.Invoke this method on background thread to avoid NetworkOnMainThreadException, because HTTP request is executed on same thread where this method is invoked.
- Parameters:
accountRanges
- List of the starting numbers of the account ranges to retrieve the eligible token requestors for.- Returns:
- Eligible Token Requestors as list of
MppTokenRequestor
object instances. - Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getEligibleTokenRequestorsForAccountRanges
public static void getEligibleTokenRequestorsForAccountRanges(@NonNull List<String> accountRanges, @Nullable MppGetTokenRequestorsListener listener) Retrieves eligible Token Requestors which support push provisioning for provided account ranges. Once list of requestors is received, user has an option to select the one to be used.- Parameters:
accountRanges
- Array of the starting numbers of the account ranges to retrieve the eligible token requestors for.listener
- The listener asMppGetTokenRequestorsListener
interface.
-
getEligibleTokenRequestors
public static List<MppTokenRequestor> getEligibleTokenRequestors(@NonNull MppCardDataParameters cardData) throws MppException, NetworkOnMainThreadException Retrieves eligible Token Requestors which support push provisioning for provided account ranges. Once the list of requestors is received, user has an option to select the one to be used.Invoke this method on background thread to avoid NetworkOnMainThreadException, because HTTP request is executed on same thread where this method is invoked.
- Parameters:
cardData
- Card data object containing the card information to be provisioned by the token requestor.- Returns:
- Eligible Token Requestors as list of
MppTokenRequestor
object instances. - Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getEligibleTokenRequestors
public static void getEligibleTokenRequestors(@NonNull MppCardDataParameters cardData, @NonNull MppGetTokenRequestorsListener listener) Retrieves eligible Token Requestors which support push provisioning for provided account ranges. Once list of requestors is received, user has an option to select the one to be used.- Parameters:
cardData
- Card data object containing the card information to be provisioned by the token requestor.listener
- The listener asMppGetTokenRequestorsListener
interface.
-
getEligibleTokenRequestorsForCards
@WorkerThread public static List<MppTokenRequestor> getEligibleTokenRequestorsForCards(@NonNull List<MppCardDataParameters> cards) throws MppException, NetworkOnMainThreadException Retrieves eligible Token Requestors which support push provisioning for provided cards. Once the list of requestors is received, user has an option to select the one to be used.- Parameters:
cards
- List of card data objects containing the card information to be provisioned by the token requestor. It must contain either CardId/CardSecret or Encrypted Pan data only.- Returns:
- Eligible Token Requestors as list of
MppTokenRequestor
object instances. - Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getEligibleTokenRequestorsForCards
public static void getEligibleTokenRequestorsForCards(@NonNull List<MppCardDataParameters> cards, @NonNull MppGetTokenRequestorsListener listener) Retrieves eligible Token Requestors which support push provisioning for provided cards. Once the list of requestors is received, user has an option to select the one to be used.- Parameters:
cards
- List of card data objects containing the card information to be provisioned by the token requestor. It must contain either CardId/CardSecret or Encrypted Pan data only.listener
- The listener asMppGetTokenRequestorsListener
interface.
-
getTokenizationReceipt
public static MppGetTokenizationReceiptResponseData getTokenizationReceipt(@NonNull String tokenRequestorId, @NonNull MppCardDataParameters cardData, @NonNull Context context) throws MppException, NetworkOnMainThreadException Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned bygetEligibleTokenRequestors(MppCardDataParameters)
method. In response Token Requestor will return a receipt, which needs to be provided to a merchant or any other instance where the card will be digitized in. Receipt can be a deep-link to a bank's or merchant application, and it can also be a URL to a web page. If the Android app URI is supplied, redirect to the web browser should remain a backup solution only.- Parameters:
tokenRequestorId
- Identifies the Token Requestor, received in response from #getEligibleTokenRequestors(MppCardDataParameters)} method.cardData
- Card data object containing the card information to be provisioned by the token requestor.context
- Application context.- Returns:
- Push account receipt and available push methods.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getTokenizationReceipt
public static void getTokenizationReceipt(@NonNull String tokenRequestorId, @NonNull MppCardDataParameters cardData, @NonNull Context context, @Nullable MppGetTokenizationReceiptListener listener) Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned by #getEligibleTokenRequestors(MppCardDataParameters)} method. In response Token Requestor will return a receipt, which needs to be provided to a merchant or any other instance where the card will be digitized in. Receipt can be a deep-link to a bank's or merchant application, and it can also be a URL to a web page. If the Android app URI is supplied, redirect to the web browser should remain a backup solution only- Parameters:
tokenRequestorId
- Identifies the Token Requestor, received in response from #getEligibleTokenRequestors(MppCardDataParameters)} method.cardData
- Card data object containing the card information to be provisioned by the token requestor.context
- Application context.listener
- The listener asMppGetTokenizationReceiptListener
interface.
-
getTokenizationReceipt
public static MppGetTokenizationReceiptResponseData getTokenizationReceipt(@NonNull String tokenRequestorId, @NonNull MppCardDataParameters cardData, @Nullable MppIntent intent, @NonNull Context context) throws MppException, NetworkOnMainThreadException Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned by #getEligibleTokenRequestors(MppCardDataParameters)} method. In response Token Requestor will return a receipt, which needs to be provided to a merchant or any other instance where the card will be digitized in. Receipt can be a deep-link to a bank's or merchant application, and it can also be a URL to a web page. If the Android app URI is supplied, redirect to the web browser should remain a backup solution only.- Parameters:
tokenRequestorId
- Identifies the Token Requestor, received in response from #getEligibleTokenRequestors(MppCardDataParameters)} method.cardData
- Card data object containing the card information to be provisioned by the token requestor.intent
- Optional, required for VISA. The intent helps VCEH to determine the relevant user experience. PUSH_PROV_MOBILE, PUSH_PROV_ONFILE - Synchronous flow. Enrollment of card credentials is completed as part of the same session on the same device as issuer and TR. PUSH_PROV_CROSS_USER, PUSH_PROV_CROSS_DEVICE - Asynchronous flow.context
- Application context.- Returns:
- Push account receipt and available push methods.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getTokenizationReceipt
public static void getTokenizationReceipt(@NonNull String tokenRequestorId, @NonNull MppCardDataParameters cardData, @Nullable MppIntent intent, @NonNull Context context, @Nullable MppGetTokenizationReceiptListener listener) Pushes particular card data to a selected Token Requestor, Token Requestor selection is done from the list of eligible Token Requestors previously returned by {#getEligibleTokenRequestors(MppCardDataParameters)} method. In response Token Requestor will return a receipt, which needs to be provided to a merchant or any other instance where the card will be digitized in. Receipt can be a deep-link to a bank's or merchant application, and it can also be a URL to a web page. If the Android app URI is supplied, redirect to the web browser should remain a backup solution only- Parameters:
tokenRequestorId
- Identifies the Token Requestor, received in response from #getEligibleTokenRequestors(MppCardDataParameters)} method.cardData
- Card data object containing the card information to be provisioned by the token requestor.intent
- Optional, required for VISA. The intent helps VCEH to determine the relevant user experience. PUSH_PROV_MOBILE, PUSH_PROV_ONFILE - Synchronous flow. Enrollment of card credentials is completed as part of the same session on the same device as issuer and TR. PUSH_PROV_CROSS_USER, PUSH_PROV_CROSS_DEVICE - Asynchronous flow.context
- Application context.listener
- The listener asMppGetTokenizationReceiptListener
interface.
-
getGooglePayTokens
@Deprecated public static MppGetTokensResponseData getGooglePayTokens(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context) throws MppException, NetworkOnMainThreadException Deprecated.Get Google Pay tokens for the specified card. Synchronous method.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.- Returns:
- Returns data containing card payment network, last four digits and related tokens.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getGooglePayTokens
@Deprecated public static void getGooglePayTokens(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context, @NonNull MppGetTokensListener listener) Deprecated.Get Google Pay tokens for the specified card. Asynchronous method.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.listener
- The listener asMppGetTokensListener
interface.
-
getGooglePayTokenizationData
@Deprecated public static MppGetOemTokenizationDataResponseData getGooglePayTokenizationData(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context) throws MppException, NetworkOnMainThreadException Deprecated.Get Google Pay Push Provisioning tokenization data which includes Opaque Payment Card (OPC) - a binary blob of information which needs to be shared with Google Pay 'as is' and will be presented to TSP to receive a token.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.- Returns:
- return Opaque Payment Card (OPC) - a binary blob of information which needs to be shared with Google Pay 'as is' and will be presented to TSP to receive a token.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getGooglePayTokenizationData
@Deprecated public static void getGooglePayTokenizationData(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context, @NonNull MppGetOemTokenizationDataListener listener) Deprecated.Get Google Pay Push Provisioning tokenization data. In listener onSuccess() callback return Opaque Payment Card (OPC) - a binary blob of information which needs to be shared with Google Pay 'as is' and will be presented to TSP to receive a token.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.listener
- The listener asMppGetOemTokenizationDataListener
interface.
-
getSamsungPayTokens
@Deprecated public static MppGetTokensResponseData getSamsungPayTokens(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context) throws MppException, NetworkOnMainThreadException Deprecated.Get Samsung Pay tokens for the specified card. Synchronous method.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.- Returns:
- Returns data containing card payment network, last four digits and related tokens.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getSamsungPayTokens
@Deprecated public static void getSamsungPayTokens(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context, @NonNull MppGetTokensListener listener) Deprecated.Get Samsung Pay tokens for the specified card. Asynchronous method.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.listener
- The listener asMppGetTokensListener
interface.
-
getSamsungPayTokenizationData
@Deprecated public static MppGetOemTokenizationDataResponseData getSamsungPayTokenizationData(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context) throws MppException, NetworkOnMainThreadException Deprecated.Get Samsung Pay Push Provisioning tokenization data which includes Opaque Payment Card (OPC) - a binary blob of information which needs to be shared with Samsung Pay 'as is' and will be presented to TSP to receive a token.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.- Returns:
- return Opaque Payment Card (OPC) - a binary blob of information which needs to be shared with Google Pay 'as is' and will be presented to TSP to receive a token.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getSamsungPayTokenizationData
@Deprecated public static void getSamsungPayTokenizationData(@NonNull MppCardDataParameters cardData, @Nullable String walletId, @Nullable String deviceId, @NonNull Context context, @NonNull MppGetOemTokenizationDataListener listener) Deprecated.Get Samsung Pay Push Provisioning tokenization data. In listener onSuccess() callback return Opaque Payment Card (OPC) - a binary blob of information which needs to be shared with Google Pay 'as is' and will be presented to TSP to receive a token.- Parameters:
cardData
- Card data object containing the card information.walletId
- Wallet ID of the active wallet.deviceId
- Device ID of the active wallet.context
- Application context.listener
- The listener asMppGetOemTokenizationDataListener
interface.
-
getAsset
public static List<MppAsset> getAsset(@NonNull String assetId) throws MppException, NetworkOnMainThreadException Gets static Assets from MDESs repository, such as: Card art, Mastercard brand logos, Issuers logos, Terms and Conditions. Every Asset in the repository is referenced using an Asset ID. Once an Asset has been assigned to an Asset ID, the contents of the Asset will not change.- Parameters:
assetId
- Asset ID value used to reference an Asset.- Returns:
- Static assets as list of
MppAsset
objects. - Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getAsset
Gets static Assets from MDESs repository, such as: Card art, Mastercard brand logos, Issuers logos, Terms and Conditions. Every Asset in the repository is referenced using an Asset ID. Once an Asset has been assigned to an Asset ID, the contents of the Asset will not change.- Parameters:
assetId
- Asset ID value used to reference an Asset.listener
- The listener asMppGetAssetListener
interface.
-
sendUserToTokenRequestor
public static void sendUserToTokenRequestor(@NonNull Activity activity, @Nullable String applicationUri, @Nullable String webUri, @Nullable String pushAccountReceiptParameter, @Nullable String callbackUrlParameter, @Nullable Boolean completeIssuerAppActivationParameter, @Nullable Boolean completeWebsiteActivationParameter) throws MppException Helper method to start the Token Requestor Application activity if it's safe, else the Browser activity, using URI data obtained fromgetTokenizationReceipt(String, MppCardDataParameters, Context)
. Optionally issuer application can provide URI parameters, which will be appended to URI request.- Parameters:
activity
- Activity from which to launch a new activity.applicationUri
- URI value withMppPushMethod.ANDROID
type, obtained fromgetTokenizationReceipt(String, MppCardDataParameters, Context)
.webUri
- URI value withMppPushMethod.WEB
type, obtained fromgetTokenizationReceipt(String, MppCardDataParameters, Context)
.pushAccountReceiptParameter
- The pushAccountReceipts value obtained fromgetTokenizationReceipt(String, MppCardDataParameters, Context)
. If the User had selected a Token Requestor supporting multiple cards, application can pass multiple pushAccountReceipts separated by commas.callbackUrlParameter
- The URL for the Token Requestor to use to pass control back to the Issuer. This needs to be an absolute URL containing the scheme. If the Issuer wishes to redirect to their banking app (iOS or Android), the URL must contain a custom URI scheme.completeIssuerAppActivationParameter
- Boolean value used to drive the behavior of the Token Requestor if a provisioning request receives a decision of REQUIRE_ADDITIONAL_AUTHENTICATION.completeWebsiteActivationParameter
- Boolean value used to drive the behavior of the Token Requestor if a provisioning request receives a decision of REQUIRE_ADDITIONAL_AUTHENTICATION.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
getTokenUniqueReference
Gets Token Unique Reference from Intent payload.- Parameters:
intent
- Intent- Returns:
- Token Unique Reference or null, if it's not found.
-
check
public static void check(@Nullable String tokenRequestorId, @NonNull MppCardDataParameters cardData, @NonNull MppGetTokensListener listener) throws MppException Checks if specified card is added to selected Token Requestor.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.cardData
- Card data object containing the card information.listener
- The listener asMppGetTokensListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
check
public static MppGetTokensResponseData check(@Nullable String tokenRequestorId, @NonNull MppCardDataParameters cardData) throws MppException Checks if specified card is added to selected Token Requestor.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.cardData
- Card data object containing the card information.- Returns:
- Returns data containing card payment network, last four digits and related tokens.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
push
@Deprecated public static void push(@Nullable String tokenRequestorId, @NonNull MppCardDataParameters cardParams, @NonNull MppConsumerInformation consumerInformation, @NonNull MppBillingAddress billingAddress, @NonNull MppPushListener listener) throws MppException Deprecated.Pushes (enroll) specified card to selected Token Requestor / Click to Pay.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.cardParams
- Card data object containing the card information.consumerInformation
- Consumer information.billingAddress
- Billing address.listener
- The listener asMppPushListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
push
public static void push(@Nullable String tokenRequestorId, @NonNull MppCardDataParameters cardParams, @NonNull MppConsumerInformation consumerInformation, @NonNull MppBillingAddress billingAddress, @NonNull MppPushResponseDataListener listener) throws MppException Pushes (enroll) specified card to selected Token Requestor / Click to Pay.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.cardParams
- Card data object containing the card information.consumerInformation
- Consumer information.billingAddress
- Billing address.listener
- The listener asMppPushResponseDataListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
push
public static MppPushResponseData push(@Nullable String tokenRequestorId, @NonNull MppCardDataParameters cardParams, @NonNull MppConsumerInformation consumerInformation, @NonNull MppBillingAddress billingAddress) throws MppException, NetworkOnMainThreadException Pushes (enroll) specified card to selected Token Requestor / Click to Pay.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.cardParams
- Card data object containing the card information.consumerInformation
- Consumer information.billingAddress
- Billing address.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getConsumerDetails
@Deprecated public static void getConsumerDetails(@Nullable String tokenRequestorId, @NonNull String externalConsumerId, @NonNull MppConsumerDetailsListener listener) throws MppException Deprecated.Retrieves consumer and cards (payment instrument) information.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.listener
- The listener asMppConsumerDetailsListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
getConsumerDetails
public static void getConsumerDetails(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId, @NonNull MppConsumerDetailsListener listener) throws MppException Retrieves consumer and cards (payment instrument) information.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.listener
- The listener asMppConsumerDetailsListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
getConsumerDetails
@Deprecated public static MppConsumerDetails getConsumerDetails(@Nullable String tokenRequestorId, @NonNull String externalConsumerId) throws MppException, NetworkOnMainThreadException Deprecated.Retrieves consumer and cards (payment instrument) information.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.- Returns:
- Returns consumer details.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getConsumerDetails
public static MppConsumerDetails getConsumerDetails(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId) throws MppException, NetworkOnMainThreadException Retrieves consumer and cards (payment instrument) information.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.- Returns:
- Returns consumer details.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
getConsumerRequestStatus
public static void getConsumerRequestStatus(@Nullable String tokenRequestorId, @NonNull String requestTraceId, @NonNull MppConsumerStatusListener listener) throws MppException Retrieves consumer request status.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.requestTraceId
- Request trace Id.listener
- The listener asMppConsumerStatusListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
getConsumerRequestStatus
public static MppConsumerRequestStatus getConsumerRequestStatus(@Nullable String tokenRequestorId, @NonNull String requestTraceId) throws MppException, NetworkOnMainThreadException Retrieves consumer request status.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.requestTraceId
- Request trace Id.- Returns:
- Returns consumer request status.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
updateConsumerDetails
@Deprecated public static void updateConsumerDetails(@Nullable String tokenRequestorId, @NonNull MppConsumerInformation consumerInformation, @NonNull MppPushListener listener) throws MppException Deprecated.Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.consumerInformation
- Consumer information.listener
- The listener asMppPushListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
updateConsumerDetails
public static void updateConsumerDetails(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull MppConsumerInformation consumerInformation, @NonNull MppPushResponseDataListener listener) throws MppException Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.consumerInformation
- Consumer information.listener
- The listener asMppConsumerDetailsListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
updateConsumerDetails
@Deprecated public static MppPushResponseData updateConsumerDetails(@Nullable String tokenRequestorId, @NonNull MppConsumerInformation consumerInformation) throws MppException, NetworkOnMainThreadException Deprecated.Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.consumerInformation
- Consumer information.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
updateConsumerDetails
public static MppPushResponseData updateConsumerDetails(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull MppConsumerInformation consumerInformation) throws MppException, NetworkOnMainThreadException Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.consumerInformation
- Consumer information.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
deleteConsumer
@Deprecated public static void deleteConsumer(@Nullable String tokenRequestorId, @NonNull String externalConsumerId, @NonNull MppPushListener listener) throws MppException Deprecated.Deletes consumer information and all cards (payment instruments) related to the profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.listener
- The listener asMppPushListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
deleteConsumer
public static void deleteConsumer(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId, @NonNull MppPushResponseDataListener listener) throws MppException Deletes consumer information and all cards (payment instruments) related to the profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment network.externalConsumerId
- External consumer Id.listener
- The listener asMppConsumerDetailsListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
deleteConsumer
@Deprecated public static MppPushResponseData deleteConsumer(@Nullable String tokenRequestorId, @NonNull String externalConsumerId) throws MppException, NetworkOnMainThreadException Deprecated.UsedeleteConsumer(String, MppPaymentNetwork, String)
instead.Deletes consumer information and all cards (payment instruments) related to the profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
deleteConsumer
public static MppPushResponseData deleteConsumer(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId) throws MppException, NetworkOnMainThreadException Deletes consumer information and all cards (payment instruments) related to the profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
updateCardDetails
@Deprecated public static void updateCardDetails(@Nullable String tokenRequestorId, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @NonNull String cardholderName, @NonNull String expiryYear, @NonNull String expiryMonth, @NonNull MppBillingAddress billingAddress, @NonNull MppPushListener listener) throws MppException Deprecated.Updates card details.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.cardholderName
- Cardholder name.expiryYear
- Expiry year.expiryMonth
- Expiry month.billingAddress
- Billing addresslistener
- The listener asMppPushListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
updateCardDetails
public static void updateCardDetails(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @NonNull String cardholderName, @NonNull String expiryYear, @NonNull String expiryMonth, @NonNull MppBillingAddress billingAddress, @Nullable String externalCardId, @NonNull MppPushResponseDataListener listener) throws MppException Updates card details.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.cardholderName
- Cardholder name.expiryYear
- Expiry year.expiryMonth
- Expiry month.billingAddress
- Billing address.externalCardId
- External card id.listener
- The listener asMppConsumerDetailsListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
updateCardDetails
@Deprecated public static MppPushResponseData updateCardDetails(@Nullable String tokenRequestorId, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @NonNull String cardholderName, @NonNull String expiryYear, @NonNull String expiryMonth, @NonNull MppBillingAddress billingAddress) throws MppException, NetworkOnMainThreadException Deprecated.Updates card details.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.cardholderName
- Cardholder name.expiryYear
- Expiry year.expiryMonth
- Expiry month.billingAddress
- Billing address- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
updateCardDetails
public static MppPushResponseData updateCardDetails(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @NonNull String cardholderName, @NonNull String expiryYear, @NonNull String expiryMonth, @NonNull MppBillingAddress billingAddress, @Nullable String externalCardId) throws MppException, NetworkOnMainThreadException Updates card details.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.cardholderName
- Cardholder name.expiryYear
- Expiry year.expiryMonth
- Expiry month.billingAddress
- Billing addressexternalCardId
- External card id.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
deleteCard
@Deprecated public static void deleteCard(@Nullable String tokenRequestorId, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @NonNull MppPushListener listener) throws MppException Deprecated.Deletes card (payment instrument) information from consumer profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.listener
- The listener asMppPushListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
deleteCard
public static void deleteCard(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @Nullable String externalCardId, @NonNull MppPushResponseDataListener listener) throws MppException Deletes card (payment instrument) information from consumer profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.externalCardId
- External Card Id.listener
- The listener asMppPushResponseDataListener
interface.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
deleteCard
@Deprecated public static MppPushResponseData deleteCard(@Nullable String tokenRequestorId, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams) throws MppException, NetworkOnMainThreadException Deprecated.Deletes card (payment instrument) information from consumer profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
deleteCard
public static MppPushResponseData deleteCard(@Nullable String tokenRequestorId, @NonNull MppPaymentNetwork paymentNetwork, @NonNull String externalConsumerId, @NonNull MppCardDataParameters cardParams, @Nullable String externalCardId) throws MppException, NetworkOnMainThreadException Deletes card (payment instrument) information from consumer profile.- Parameters:
tokenRequestorId
-ClickToPay
or eligible Token Requestor Id.paymentNetwork
- Payment Network.externalConsumerId
- External consumer Id.cardParams
- Card data object containing the card information.externalCardId
- External card id.- Returns:
- Returns data containing request trace Id and external consumer Id.
- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.NetworkOnMainThreadException
- Method should not be called on the Main thread.
-
delete
Deletes all the local data of MPP SDK and turns it into an uninitialized state.- Throws:
MppException
- UseMppException.getMppError()
()} to get error object with error code and error description.
-
deleteCard(String, MppPaymentNetwork, String, MppCardDataParameters, String)
instead.