MeaPushProvisioning Class Reference

Inherits from	NSObject
Declared in	MeaPushProvisioning.h MeaPushProvisioning.m

Overview

Provides API for interaction with the MeaPushProvisioning library using class methods.

Other Methods

`+ paymentAppInstanceId`

Returns payment app instance id.

+ (NSString *_Nonnull)paymentAppInstanceId

Return Value

Payment app instance id.

Discussion

Returns payment app instance id.

Method returns paymentAppInstanceId if it exists or generates a new one.

Declared In

MeaPushProvisioning.h

`+ loadConfig:`

Loads provided client configuration file.

+ (void)loadConfig:(NSString *_Nonnull)configFileName

Parameters

`configFileName`	File name of the provided client configuration file.

Discussion

Loads provided client configuration file.

Declared In

MeaPushProvisioning.h

`+ configurationHash`

Returns hash of the loaded configuration.

+ (NSString *_Nonnull)configurationHash

Return Value

hash of the loaded configuration or an empty string when configuration is not loaded.

Discussion

Returns hash of the loaded configuration.

Declared In

MeaPushProvisioning.h

`+ versionCode`

Returns version code of the SDK.

+ (NSString *)versionCode

Return Value

Version code.

Discussion

Returns version code of the SDK.

Declared In

MeaPushProvisioning.h

`+ versionName`

Returns version name of the SDK.

+ (NSString *)versionName

Return Value

Version name.

Discussion

Returns version name of the SDK.

Example: “mpp-test-1.0.0”

Declared In

MeaPushProvisioning.h

`+ setDebugLoggingEnabled:`

Switch enable/disable debug logging.

+ (void)setDebugLoggingEnabled:(BOOL)enabled

Parameters

`enabled`	Enable or disable debug logging.

Discussion

Switch enable/disable debug logging.

Declared In

MeaPushProvisioning.h

`+ initializeOemTokenization:completionHandler:`

Initiate in-app push provisioning with MppCardDataParameters parameter.

+ (void)initializeOemTokenization:(MppCardDataParameters *_Nonnull)cardDataParameters completionHandler:(void ( ^ ) ( MppInitializeOemTokenizationResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`cardDataParameters`	Card data parameters as instance of MppCardDataParameters containing the card information.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: MppInitializeOemTokenizationResponseData `_Nullable data` -Initialization response data in case of success `NSError _Nullable error` - Error object in case of failure

cardDataParameters

Card data parameters as instance of MppCardDataParameters containing the card information.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

MppInitializeOemTokenizationResponseData *_Nullable data -Initialization response data in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

Initiate in-app push provisioning with MppCardDataParameters parameter.

Check if the payment card can be added to Apple Pay by using primaryAccountIdentifier in response.

Declared In

MeaPushProvisioning.h

`+ completeOemTokenization:completionHandler:`

Complete in-app push provisioning. Exchanges Apple certificates and signature with Issuer Host.

+ (void)completeOemTokenization:(MppCompleteOemTokenizationData *_Nonnull)tokenizationData completionHandler:(void ( ^ ) ( MppCompleteOemTokenizationResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenizationData`	Card data parameters as instance of MppCardDataParameters containing the card information.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: MppCompleteOemTokenizationResponseData `_Nullable data` - Completition response data in case of success `NSError _Nullable error` - Error object in case of failure

tokenizationData

Card data parameters as instance of MppCardDataParameters containing the card information.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

MppCompleteOemTokenizationResponseData *_Nullable data - Completition response data in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

Complete in-app push provisioning. Exchanges Apple certificates and signature with Issuer Host.

Delegate should implement PKAddPaymentPassViewControllerDelegate protocol to call completeOemTokenization:completionHandler: method, once the data is exchanged PKAddPaymentPassRequest is passed to the handler to add the payment card to Apple Wallet. In the end and delegate method is invoked to inform you if request has succeeded or failed.

Declared In

MeaPushProvisioning.h

`+ getActivationData:completionHandler:`

Method gets activation data (cryptographic OTP) for the Secure Element pass activation via activateSecureElementPass:withActivationData:completionHandler:

+ (void)getActivationData:(MppCardDataParameters *_Nonnull)cardDataParameters completionHandler:(void ( ^ ) ( NSString *_Nullable activationData , NSError *_Nullable error ))completionHandler

Parameters

`cardDataParameters`	Card data parameters as instance of MppCardDataParameters containing the card information.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: `NSString _Nullable activationData` - Activation data string in case of success `NSError _Nullable error` - Error object in case of failure

cardDataParameters

Card data parameters as instance of MppCardDataParameters containing the card information.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

NSString *_Nullable activationData - Activation data string in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

Method gets activation data (cryptographic OTP) for the Secure Element pass activation via activateSecureElementPass:withActivationData:completionHandler:

Declared In

MeaPushProvisioning.h

`+ activateSecureElementPass:withActivationData:completionHandler:`

Activates a Secure Element pass using Activation Data.

+ (void)activateSecureElementPass:(PKSecureElementPass *_Nonnull)secureElementPass withActivationData:(NSString *_Nonnull)activationData completionHandler:(void ( ^ ) ( BOOL success , NSError *_Nullable error ))completionHandler

Parameters

`secureElementPass`	The Secure Element pass to activate.
`activationData`	A cryptographic value that the activation process requires as hex string.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: `BOOL success` - `true` if the pass activates; otherwise, `false` `NSError *_Nullable error` - Error object in case of failure

secureElementPass

The Secure Element pass to activate.

activationData

A cryptographic value that the activation process requires as hex string.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

BOOL success - true if the pass activates; otherwise, false
NSError *_Nullable error - Error object in case of failure

Discussion

Activates a Secure Element pass using Activation Data.

Declared In

MeaPushProvisioning.h

`+ activateSecureElementPass:withPaymentNetwork:completionHandler:`

Activates a Secure Element pass.

+ (void)activateSecureElementPass:(PKSecureElementPass *_Nonnull)secureElementPass withPaymentNetwork:(PKPaymentNetwork _Nonnull)paymentNetwork completionHandler:(void ( ^ ) ( BOOL success , NSError *_Nullable error ))completionHandler

Parameters

`secureElementPass`	The Secure Element pass to activate.
`paymentNetwork`	Paymenent network.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: `BOOL success` - `true` if the pass activates; otherwise, `false` `NSError *_Nullable error` - Error object in case of failure

secureElementPass

The Secure Element pass to activate.

paymentNetwork

Paymenent network.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

BOOL success - true if the pass activates; otherwise, false
NSError *_Nullable error - Error object in case of failure

Discussion

Activates a Secure Element pass.

Declared In

MeaPushProvisioning.h

`+ canAddSecureElementPassWithPrimaryAccountIdentifier:`

Verify if primaryAccountIdentifier can be used to add payment pass to iPhone Wallet and/or Watch.

+ (BOOL)canAddSecureElementPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if payment pass can be added with given primaryAccountIdentifier.

Discussion

Verify if primaryAccountIdentifier can be used to add payment pass to iPhone Wallet and/or Watch.

Declared In

MeaPushProvisioning.h

`+ canAddSecureElementPassWithPrimaryAccountNumberSuffix:`

Verify if primaryAccountNumberSuffix can be used to add payment pass. Check is specific for iPhone Wallet.

+ (BOOL)canAddSecureElementPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if payment pass can be added with given primaryAccountNumberSuffix.

Discussion

Verify if primaryAccountNumberSuffix can be used to add payment pass. Check is specific for iPhone Wallet.

Declared In

MeaPushProvisioning.h

`+ secureElementPassExistsWithPrimaryAccountIdentifier:`

Verify if payment pass exists with primaryAccountIdentifier. Check is specific for iPhone Wallet.

+ (BOOL)secureElementPassExistsWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if payment pass exists with given primaryAccountIdentifier.

Discussion

Verify if payment pass exists with primaryAccountIdentifier. Check is specific for iPhone Wallet.

Declared In

MeaPushProvisioning.h

`+ remoteSecureElementPassExistsWithPrimaryAccountIdentifier:`

Verify if remote payment pass exists with primaryAccountIdentifier. Check is specific for Watch. Call when watch is paired.

+ (BOOL)remoteSecureElementPassExistsWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if remote payment pass exists with given primaryAccountIdentifier.

Discussion

Verify if remote payment pass exists with primaryAccountIdentifier. Check is specific for Watch. Call when watch is paired.

Declared In

MeaPushProvisioning.h

`+ secureElementPassExistsWithPrimaryAccountNumberSuffix:`

Verify if payment pass exists with primaryAccountNumberSuffix. Check is specific for iPhone.

+ (BOOL)secureElementPassExistsWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if payment pass exists with given primaryAccountNumberSuffix.

Discussion

Verify if payment pass exists with primaryAccountNumberSuffix. Check is specific for iPhone.

Declared In

MeaPushProvisioning.h

`+ remoteSecureElementPassExistsWithPrimaryAccountNumberSuffix:`

Verify if remote payment pass exists with primaryAccountNumberSuffix. Check is specific for Watch. Call when watch is paired.

+ (BOOL)remoteSecureElementPassExistsWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if remote payment pass exists with given primaryAccountNumberSuffix.

Discussion

Verify if remote payment pass exists with primaryAccountNumberSuffix. Check is specific for Watch. Call when watch is paired.

Declared In

MeaPushProvisioning.h

`+ secureElementPassWithPrimaryAccountIdentifier:`

Returns secure element pass with primaryAccountIdentifier.

+ (PKSecureElementPass *)secureElementPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if remote secure element can be added with given primaryAccountIdentifier. Returns true if Watch is not paired.

Discussion

Returns secure element pass with primaryAccountIdentifier.

Declared In

MeaPushProvisioning.h

`+ secureElementPassWithPrimaryAccountNumberSuffix:`

Returns secure element pass with primaryAccountNumberSuffix.

+ (PKSecureElementPass *)secureElementPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if payment pass can be added with given primaryAccountNumberSuffix. Returns true if Watch is not paired.

Discussion

Returns secure element pass with primaryAccountNumberSuffix.

Declared In

MeaPushProvisioning.h

`+ remoteSecureElementPassWithPrimaryAccountIdentifier:`

Returns secure element pass with primaryAccountIdentifier.

+ (PKSecureElementPass *)remoteSecureElementPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

remote secure element pass.

Discussion

Returns secure element pass with primaryAccountIdentifier.

Declared In

MeaPushProvisioning.h

`+ remoteSecureElementPassWithPrimaryAccountNumberSuffix:`

Returns remote secure element pass with primaryAccountNumberSuffix.

+ (PKSecureElementPass *)remoteSecureElementPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

remote secure element pass.

Discussion

Returns remote secure element pass with primaryAccountNumberSuffix.

Declared In

MeaPushProvisioning.h

`+ secureElementPassWithSerialNumber:`

Returns secure element pass with serialNumber.

+ (PKSecureElementPass *)secureElementPassWithSerialNumber:(NSString *_Nonnull)serialNumber

Parameters

`serialNumber`	Serial number.

Return Value

secure element pass.

Discussion

Returns secure element pass with serialNumber.

Declared In

MeaPushProvisioning.h

`+ remoteSecureElementPassWithSerialNumber:`

Returns remote secure element pass with serialNumber.

+ (PKSecureElementPass *)remoteSecureElementPassWithSerialNumber:(NSString *_Nonnull)serialNumber

Parameters

`serialNumber`	Serial number.

Return Value

remote secure element pass.

Discussion

Returns remote secure element pass with serialNumber.

Declared In

MeaPushProvisioning.h

`+ presentSecureElementPassWithPrimaryAccountIdentifier:`

Presents a Secure Element pass with Primary Account Identifier.

+ (void)presentSecureElementPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Discussion

Presents a Secure Element pass with Primary Account Identifier.

Declared In

MeaPushProvisioning.h

`+ presentSecureElementPassWithPrimaryAccountNumberSuffix:`

Presents a Secure Element pass with PAN Suffix.

+ (void)presentSecureElementPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Discussion

Presents a Secure Element pass with PAN Suffix.

Declared In

MeaPushProvisioning.h

`+ isWatchPaired:`

Checks if Watch is paired.

+ (void)isWatchPaired:(void ( ^ ) ( BOOL paired ))completion

Parameters

`completion`	The code block invoked when request is completed. Returns true if Watch is paired.

Discussion

Checks if Watch is paired.

Declared In

MeaPushProvisioning.h

`+ canAddRemoteSecureElementPassWithPrimaryAccountIdentifier:`

Checks if remote payment pass with primaryAccountIdentifier can be added.

+ (BOOL)canAddRemoteSecureElementPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Return Value

Bool value if payment pass can be added with given primaryAccountIdentifier. Returns true if Watch is not paired.

Discussion

Checks if remote payment pass with primaryAccountIdentifier can be added.

Declared In

MeaPushProvisioning.h

`+ canAddRemoteSecureElementPassWithPrimaryAccountNumberSuffix:`

Checks if remote payment pass with primaryAccountNumberSuffix can be added.

+ (BOOL)canAddRemoteSecureElementPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Return Value

Bool value if payment pass can be added with given primaryAccountNumberSuffix. Returns true if Watch is not paired.

Discussion

Checks if remote payment pass with primaryAccountNumberSuffix can be added.

Declared In

MeaPushProvisioning.h

`+ canAddRemoteSecureElementPassWithPrimaryAccountIdentifier:completion:`

Checks if remote payment pass with primaryAccountIdentifier can be added.

+ (void)canAddRemoteSecureElementPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier completion:(void ( ^ ) ( BOOL canAdd ))completion

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.
`completion`	The code block invoked when request is completed, with Boolean argument set to true if remote payment pass can be added.

Discussion

Checks if remote payment pass with primaryAccountIdentifier can be added.

Declared In

MeaPushProvisioning.h

`+ canAddRemoteSecureElementPassWithPrimaryAccountNumberSuffix:completion:`

Checks if remote payment pass with primaryAccountNumberSuffix can be added.

+ (void)canAddRemoteSecureElementPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix completion:(void ( ^ ) ( BOOL canAdd ))completion

Parameters

`primaryAccountNumberSuffix`	PAN suffix.
`completion`	The code block invoked when request is completed, with Boolean argument set to true if remote payment pass can be added.

Discussion

Checks if remote payment pass with primaryAccountNumberSuffix can be added.

Declared In

MeaPushProvisioning.h

`+ passes`

Passes in the user’s pass library that the app can access.

+ (NSArray<PKPass*> *)passes

Return Value

Passes in the user’s pass library that the app can access.

Discussion

Passes in the user’s pass library that the app can access.

Declared In

MeaPushProvisioning.h

`+ remoteSecureElementPasses`

Secure Element passes that PassKit stores on paired devices that the app can access.

+ (NSArray<PKSecureElementPass*> *)remoteSecureElementPasses

Return Value

Secure Element passes that PassKit stores on paired devices.

Discussion

Secure Element passes that PassKit stores on paired devices that the app can access.

Declared In

MeaPushProvisioning.h

`+ getEligibleTokenRequestors:completionHandler:`

Retrieves eligible Token Requestors which support push provisioning for provided card data.

+ (void)getEligibleTokenRequestors:(MppCardDataParameters *_Nonnull)cardDataParameters completionHandler:(void ( ^ ) ( MppGetTokenRequestorsResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`cardDataParameters`	Card data parameters as instance of MppCardDataParameters containing the card information to be provisioned by the token requestor.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: MppGetTokenRequestorsResponseData `_Nullable data` - Eligible Token Requestors in case of success `NSError _Nullable error` - Error object in case of failure

cardDataParameters

Card data parameters as instance of MppCardDataParameters containing the card information to be provisioned by the token requestor.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

MppGetTokenRequestorsResponseData *_Nullable data - Eligible Token Requestors in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

Retrieves eligible Token Requestors which support push provisioning for provided card data.

Once list of requestors is received, user has an option to select the one to be used.

Declared In

MeaPushProvisioning.h

`+ getEligibleTokenRequestorsForCards:completionHandler:`

Retrieves eligible Token Requestors which support push provisioning for provided cards.

+ (void)getEligibleTokenRequestorsForCards:(NSArray<MppCardDataParameters*> *_Nonnull)cards completionHandler:(void ( ^ ) ( MppGetTokenRequestorsResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`cards`	Array of the cards to retrieve the eligible token requestors for.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: MppGetTokenRequestorsResponseData `_Nullable data` - Eligible Token Requestors in case of success `NSError _Nullable error` - Error object in case of failure

cards

Array of the cards to retrieve the eligible token requestors for.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

MppGetTokenRequestorsResponseData *_Nullable data - Eligible Token Requestors in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

Retrieves eligible Token Requestors which support push provisioning for provided cards.

Once list of requestors is received, user has an option to select the one to be used.

Declared In

MeaPushProvisioning.h

`+ getEligibleTokenRequestorsForAccountRanges:completionHandler:`

Retrieves eligible Token Requestors which support push provisioning for provided account ranges.

+ (void)getEligibleTokenRequestorsForAccountRanges:(NSArray<NSString*> *_Nonnull)accountRanges completionHandler:(void ( ^ ) ( MppGetTokenRequestorsResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`accountRanges`	Array of the starting numbers of the account ranges to retrieve the eligible token requestors for.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: MppGetTokenRequestorsResponseData `_Nullable tokenRequestors` - Eligible Token Requestors in case of success `NSError _Nullable error` - Error object in case of failure

accountRanges

Array of the starting numbers of the account ranges to retrieve the eligible token requestors for.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

MppGetTokenRequestorsResponseData *_Nullable tokenRequestors - Eligible Token Requestors in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

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.

Declared In

MeaPushProvisioning.h

`+ getAsset:completionHandler:`

Gets static Assets such as: Card art, Mastercard brand logos, Issuers logos. Every Asset in the repository is referenced using an assetId.

+ (void)getAsset:(NSString *_Nonnull)assetId completionHandler:(void ( ^ ) ( MppGetAssetResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`assetId`	Asset Id value used to reference an Asset.
`completionHandler`	The code block invoked when request is completed.

Discussion

Gets static Assets such as: Card art, Mastercard brand logos, Issuers logos. Every Asset in the repository is referenced using an assetId.

Declared In

MeaPushProvisioning.h

`+ getTokenizationReceipt:cardDataParameters:completionHandler:`

Pushes particular card data to a selected Token Requestor.

+ (void)getTokenizationReceipt:(NSString *_Nonnull)tokenRequestorId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters completionHandler:(void ( ^ ) ( MppGetTokenizationReceiptResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

tokenRequestorId

Identifies the Token Requestor, received from getTokenRequestors:completionHandler: method.

cardDataParameters

Card data parameters as instance of MppCardDataParameters containing the card information to be provisioned by the token requestor.

completionHandler

The code block invoked when request is completed.

Parameters for the completionHandler:

MppGetTokenizationReceiptResponseData *_Nullable data - Tokenization receipt data in case of success
NSError *_Nullable error - Error object in case of failure

Discussion

Pushes particular card data to a selected Token Requestor.

Token Requestor selection is done from the list of eligible Token Requestors previously returned by getTokenRequestors:completionHandler: 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.

Declared In

MeaPushProvisioning.h

`+ getTokenizationReceipt:cardDataParameters:intent:completionHandler:`

Pushes particular card data to a selected Token Requestor.

+ (void)getTokenizationReceipt:(NSString *_Nonnull)tokenRequestorId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters intent:(MppIntent)intent completionHandler:(void ( ^ ) ( MppGetTokenizationReceiptResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	Identifies the Token Requestor, received from getTokenRequestors:completionHandler: method.
`cardDataParameters`	Card data parameters as instance of MppCardDataParameters 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.
`completionHandler`	The code block invoked when request is completed. Parameters for the `completionHandler`: MppGetTokenizationReceiptResponseData `_Nullable data` - Tokenization receipt data in case of success `NSError _Nullable error` - Error object in case of failure

Discussion

Pushes particular card data to a selected Token Requestor.

Declared In

MeaPushProvisioning.h

`+ check:cardDataParameters:completionHandler:`

Checks if specified card is added to selected Token Requestor / Click to Pay.

+ (void)check:(NSString *_Nullable)tokenRequestorId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters completionHandler:(void ( ^ ) ( MppCheckResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`cardDataParameters`	Card data parameters as instance of MppCardDataParameters containing the card information.
`completionHandler`	The code block invoked when request is completed.

Discussion

Checks if specified card is added to selected Token Requestor / Click to Pay.

Declared In

MeaPushProvisioning.h

`+ push:cardDataParameters:consumerInformation:billingAddress:completionHandler:`

Pushes (enroll) specified card to selected Token Requestor / Click to Pay.

+ (void)push:(NSString *_Nullable)tokenRequestorId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters consumerInformation:(MppConsumerInformation *_Nonnull)consumerInformation billingAddress:(MppBillingAddress *_Nonnull)billingAddress completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`cardDataParameters`	Card data parameters as instance of MppCardDataParameters containing the card information.
`consumerInformation`	Consumer information.
`billingAddress`	Billing address.
`completionHandler`	The code block invoked when request is completed.

Discussion

Pushes (enroll) specified card to selected Token Requestor / Click to Pay.

Declared In

MeaPushProvisioning.h

`+ getConsumerDetails:externalConsumerId:completionHandler:`

Retrieves consumer and cards (payment instrument) information. (Deprecated: Use getConsumerDetails:paymentNetwork:externalConsumerId:externalConsumerId:completionHandler: instead.)

+ (void)getConsumerDetails:(NSString *_Nullable)tokenRequestorId externalConsumerId:(NSString *_Nonnull)externalConsumerId completionHandler:(void ( ^ ) ( MppConsumerDetails *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`externalConsumerId`	External consumer Id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Retrieves consumer and cards (payment instrument) information.

Declared In

MeaPushProvisioning.h

`+ getConsumerDetails:paymentNetwork:externalConsumerId:completionHandler:`

Retrieves consumer and cards (payment instrument) information.

+ (void)getConsumerDetails:(NSString *_Nullable)tokenRequestorId paymentNetwork:(PKPaymentNetwork _Nonnull)paymentNetwork externalConsumerId:(NSString *_Nonnull)externalConsumerId completionHandler:(void ( ^ ) ( MppConsumerDetails *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`paymentNetwork`	Payment Network.
`externalConsumerId`	External consumer Id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Retrieves consumer and cards (payment instrument) information.

Declared In

MeaPushProvisioning.h

`+ getConsumerRequestStatus:requestTraceId:completionHandler:`

Retrieves consumer request status.

+ (void)getConsumerRequestStatus:(NSString *_Nullable)tokenRequestorId requestTraceId:(NSString *_Nonnull)requestTraceId completionHandler:(void ( ^ ) ( MppConsumerRequestStatus *_Nullable consumerRequestStatus , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`requestTraceId`	Request trace Id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Retrieves consumer request status.

Declared In

MeaPushProvisioning.h

`+ updateConsumerDetails:consumerInformation:completionHandler:`

Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only. (Deprecated: Use updateConsumerDetails:paymentNetwork:consumerInformation:completionHandler: instead.)

+ (void)updateConsumerDetails:(NSString *_Nullable)tokenRequestorId consumerInformation:(MppConsumerInformation *_Nonnull)consumerInformation completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`consumerInformation`	Consumer information.
`completionHandler`	The code block invoked when request is completed.

Discussion

Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.

Declared In

MeaPushProvisioning.h

`+ updateConsumerDetails:paymentNetwork:consumerInformation:completionHandler:`

Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.

+ (void)updateConsumerDetails:(NSString *_Nullable)tokenRequestorId paymentNetwork:(PKPaymentNetwork _Nonnull)paymentNetwork consumerInformation:(MppConsumerInformation *_Nonnull)consumerInformation completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`paymentNetwork`	Payment Network.
`consumerInformation`	Consumer information.
`completionHandler`	The code block invoked when request is completed.

Discussion

Updates the consumer information such as customer name, email, or phone number. This method is applicable for Enrolled consumers only.

Declared In

MeaPushProvisioning.h

`+ deleteConsumer:externalConsumerId:completionHandler:`

Deletes consumer information and all cards (payment instruments) related to the profile. (Deprecated: Use deleteConsumer:paymentNetwork:externalConsumerId:completionHandler: instead.)

+ (void)deleteConsumer:(NSString *_Nullable)tokenRequestorId externalConsumerId:(NSString *_Nonnull)externalConsumerId completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`externalConsumerId`	External consumer Id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Deletes consumer information and all cards (payment instruments) related to the profile.

Declared In

MeaPushProvisioning.h

`+ deleteConsumer:paymentNetwork:externalConsumerId:completionHandler:`

Deletes consumer information and all cards (payment instruments) related to the profile.

+ (void)deleteConsumer:(NSString *_Nullable)tokenRequestorId paymentNetwork:(PKPaymentNetwork _Nonnull)paymentNetwork externalConsumerId:(NSString *_Nonnull)externalConsumerId completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`paymentNetwork`	Payment Network.
`externalConsumerId`	External consumer Id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Deletes consumer information and all cards (payment instruments) related to the profile.

Declared In

MeaPushProvisioning.h

`+ updateCardDetails:externalConsumerId:cardDataParameters:cardholderName:expiryYear:expiryMonth:billingAddress:completionHandler:`

Updates card details. (Deprecated: Use updateCardDetails:paymentNetwork:externalConsumerId:cardDataParameters:cardholderName:expiryYear:expiryMonth:billingAddress:externalCardId:completionHandler: instead.)

+ (void)updateCardDetails:(NSString *_Nullable)tokenRequestorId externalConsumerId:(NSString *_Nonnull)externalConsumerId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters cardholderName:(NSString *_Nonnull)cardholderName expiryYear:(NSString *_Nonnull)expiryYear expiryMonth:(NSString *_Nonnull)expiryMonth billingAddress:(MppBillingAddress *_Nonnull)billingAddress completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`externalConsumerId`	External consumer Id.
`cardDataParameters`	Card data object containing the card information.
`cardholderName`	Cardholder name.
`expiryYear`	Expiry year.
`expiryMonth`	Expiry month.
`billingAddress`	Billing address.
`completionHandler`	The code block invoked when request is completed.

Discussion

Updates card details.

Declared In

MeaPushProvisioning.h

`+ updateCardDetails:paymentNetwork:externalConsumerId:cardDataParameters:cardholderName:expiryYear:expiryMonth:billingAddress:externalCardId:completionHandler:`

Updates card details.

+ (void)updateCardDetails:(NSString *_Nullable)tokenRequestorId paymentNetwork:(PKPaymentNetwork _Nonnull)paymentNetwork externalConsumerId:(NSString *_Nonnull)externalConsumerId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters cardholderName:(NSString *_Nonnull)cardholderName expiryYear:(NSString *_Nonnull)expiryYear expiryMonth:(NSString *_Nonnull)expiryMonth billingAddress:(MppBillingAddress *_Nonnull)billingAddress externalCardId:(NSString *_Nullable)externalCardId completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`paymentNetwork`	Payment Network.
`externalConsumerId`	External consumer Id.
`cardDataParameters`	Card data object containing the card information.
`cardholderName`	Cardholder name.
`expiryYear`	Expiry year.
`expiryMonth`	Expiry month.
`billingAddress`	Billing address.
`externalCardId`	External card id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Updates card details.

Declared In

MeaPushProvisioning.h

`+ deleteCard:externalConsumerId:cardDataParameters:completionHandler:`

Deletes card (payment instrument) information from consumer profile. (Deprecated: Use deleteCard:paymentNetwork:externalConsumerId:cardDataParameters:externalCardId:completionHandler: instead.)

+ (void)deleteCard:(NSString *_Nullable)tokenRequestorId externalConsumerId:(NSString *_Nonnull)externalConsumerId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`externalConsumerId`	External consumer Id.
`cardDataParameters`	Card data object containing the card information.
`completionHandler`	The code block invoked when request is completed.

Discussion

Deletes card (payment instrument) information from consumer profile.

Declared In

MeaPushProvisioning.h

`+ deleteCard:paymentNetwork:externalConsumerId:cardDataParameters:externalCardId:completionHandler:`

Deletes card (payment instrument) information from consumer profile.

+ (void)deleteCard:(NSString *_Nullable)tokenRequestorId paymentNetwork:(PKPaymentNetwork _Nonnull)paymentNetwork externalConsumerId:(NSString *_Nonnull)externalConsumerId cardDataParameters:(MppCardDataParameters *_Nonnull)cardDataParameters externalCardId:(NSString *_Nullable)externalCardId completionHandler:(void ( ^ ) ( MppPushResponseData *_Nullable data , NSError *_Nullable error ))completionHandler

Parameters

`tokenRequestorId`	`MeaPushProvisioning.ClickToPay` or eligible Token Requestor Id.
`paymentNetwork`	Payment Network.
`externalConsumerId`	External consumer Id.
`cardDataParameters`	Card data object containing the card information.
`externalCardId`	External card Id.
`completionHandler`	The code block invoked when request is completed.

Discussion

Deletes card (payment instrument) information from consumer profile.

Declared In

MeaPushProvisioning.h

Deprecated since iOS 13.4

`+ canAddPaymentPassWithPrimaryAccountIdentifier:`

Verify if primaryAccountIdentifier can be used to add payment pass to iPhone Wallet and/or Watch.

+ (BOOL)canAddPaymentPassWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if payment pass can be added with given primaryAccountIdentifier.

Discussion

Verify if primaryAccountIdentifier can be used to add payment pass to iPhone Wallet and/or Watch.

Declared In

MeaPushProvisioning.h

`+ canAddPaymentPassWithPrimaryAccountNumberSuffix:`

Verify if primaryAccountNumberSuffix can be used to add payment pass. Check is specific for iPhone.

+ (BOOL)canAddPaymentPassWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if payment pass can be added with given primaryAccountNumberSuffix.

Discussion

Verify if primaryAccountNumberSuffix can be used to add payment pass. Check is specific for iPhone.

Declared In

MeaPushProvisioning.h

`+ paymentPassExistsWithPrimaryAccountIdentifier:`

Verify if payment pass exists with primaryAccountIdentifier. Check is specific for iPhone.

+ (BOOL)paymentPassExistsWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if payment pass exists with given primaryAccountIdentifier.

Discussion

Verify if payment pass exists with primaryAccountIdentifier. Check is specific for iPhone.

Declared In

MeaPushProvisioning.h

`+ remotePaymentPassExistsWithPrimaryAccountIdentifier:`

Verify if remote payment pass exists with primaryAccountIdentifier. Check is specific for Watch. Call when watch is paired.

+ (BOOL)remotePaymentPassExistsWithPrimaryAccountIdentifier:(NSString *_Nonnull)primaryAccountIdentifier

Parameters

`primaryAccountIdentifier`	Primary account identifier returned by initializeOemTokenization:completionHandler: method in [MppInitializeOemTokenizationResponseData primaryAccountIdentifier] property.

Return Value

Bool value if remote payment pass exists with given primaryAccountIdentifier.

Discussion

Verify if remote payment pass exists with primaryAccountIdentifier. Check is specific for Watch. Call when watch is paired.

Declared In

MeaPushProvisioning.h

`+ paymentPassExistsWithPrimaryAccountNumberSuffix:`

Verify if payment pass exists with primaryAccountNumberSuffix. Check is specific for iPhone.

+ (BOOL)paymentPassExistsWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if payment pass exists with given primaryAccountNumberSuffix.

Discussion

Verify if payment pass exists with primaryAccountNumberSuffix. Check is specific for iPhone.

Declared In

MeaPushProvisioning.h

`+ remotePaymentPassExistsWithPrimaryAccountNumberSuffix:`

Verify if remote payment pass exists with primaryAccountNumberSuffix. Check is specific for Watch. Call when watch is paired.

+ (BOOL)remotePaymentPassExistsWithPrimaryAccountNumberSuffix:(NSString *_Nonnull)primaryAccountNumberSuffix

Parameters

`primaryAccountNumberSuffix`	PAN suffix.

Return Value

Bool value if remote payment pass exists with given primaryAccountNumberSuffix.

Discussion

Verify if remote payment pass exists with primaryAccountNumberSuffix. Check is specific for Watch. Call when watch is paired.

Declared In

MeaPushProvisioning.h