EMEmvTransactionInfo Protocol Reference

Conforms to NSObject
Declared in EMEmvTransactionInfo.h

Overview

Holds consolidated information about payment transaction.

– payloadFormatIndicator required method

Defines the version of the QR Code template and hence the conventions on the identifiers, lengths, and values.

- (Byte)payloadFormatIndicator

Return Value

Returns Payload Format Indicator as byte.

Declared In

EMEmvTransactionInfo.h

– pointOfInitiationMethod required method

Identifies the communication technology (here QR Code) and whether the data is static or dynamic. This parameter is optional.

- (EMEmvPointOfInitiationMethod)pointOfInitiationMethod

Return Value

Point of Initiation Method value as enum {@link EMEmvPointOfInitiationMethod} value. If the data object is not presents returns {@link EMEmvPointOfInitiationMethod#EMEmvPointOfInitiationMethodUndefined}.

Declared In

EMEmvTransactionInfo.h

– merchantAccountInfo required method

Provides information about merchant’s account. The format and value are specific to a payment system.

- (NSArray<id<EMEmvDataObject> > *)merchantAccountInfo

Return Value

Returns list of {@link EMEmvDataObject} defining merchant account information. The list contains either instances of {@link EMEmvPrimitive} or {@link EMEmvTemplateWithGui} and {@link EMEmvDataObject#type} method should be used to distinguish them.

Declared In

EMEmvTransactionInfo.h

– merchantCategoryCode required method

Identifies merchant category code as defined by [ISO 18245] and assigned by the Acquirer.

- (NSInteger)merchantCategoryCode

Return Value

Returns numeric merchant category code as NSInteger.

Declared In

EMEmvTransactionInfo.h

– merchantName required method

Identifies “doing business as” name for the merchant, recognizable to the consumer. This name may be displayed to the consumer by the mobile application when processing the transaction.

- (NSString *)merchantName

Return Value

Returns merchant name as string.

Declared In

EMEmvTransactionInfo.h

– merchantCity required method

Identifies city of operations for the merchant. This name may be displayed to the consumer by the mobile application when processing the transaction.

- (NSString *)merchantCity

Return Value

Returns merchant city as string.

Declared In

EMEmvTransactionInfo.h

– countryCode required method

Indicates the country of the merchant acceptance device. The country may be displayed to the consumer by the mobile application when processing the transaction.

A 2-character alpha value, as defined by [ISO 3166-1 alpha 2] and assigned by the Acquirer.

- (NSString *)countryCode

Return Value

Returns country code as string.

Declared In

EMEmvTransactionInfo.h

– postalCode required method

Zip code or Pin code or Postal code of the merchant. If present, this value may be displayed to the consumer by the mobile application when processing the transaction.

This value is optional.

- (EMEmvOptional<NSString*> *)postalCode

Return Value

Returns postal code as string in {@link EMEmvOptional}.

Declared In

EMEmvTransactionInfo.h

– transactionAmount required method

The transaction amount, if known. For instance, “99.34”. If present, this value is displayed to the consumer by the mobile application when processing the transaction. If this data object is not present, the consumer is prompted to input the transaction amount to be paid to the merchant.

This value is optional.

- (EMEmvOptional<NSNumber*> *)transactionAmount

Return Value

Returns transaction amount as {@link NSNumber} in {@link EMEmvOptional}.

Declared In

EMEmvTransactionInfo.h

– currency required method

Indicates the currency code of the transaction. This value will be used by the mobile application to display a recognizable currency to the consumer whenever an amount is being displayed or whenever the consumer is prompted to enter an amount.

- (NSInteger)currency

Return Value

A 3-digit numeric currency code, as defined by [ISO 4217].

Declared In

EMEmvTransactionInfo.h

– merchantInformationLanguageTemplate required method

Indicates language Preference and Merchant Name—Alternate Language. It may contain the Merchant City—Alternate Language.

All other IDs within the Merchant Information—Language Template are RFU for EMVCo.

- (EMEmvOptional<id<EMEmvMerchantInformationLanguageTemplate> > *)merchantInformationLanguageTemplate

Return Value

Returns {@link EMEmvMerchantInformationLanguageTemplate} object in {@link EMEmvOptional}.

Declared In

EMEmvTransactionInfo.h

– tipOrConvenienceIndicator required method

Indicates whether the consumer will be prompted to enter a tip or whether the merchant has determined that a flat, or percentage convenience fee is charged.

- (EMEmvTipOrConvenienceIndicator)tipOrConvenienceIndicator

Return Value

Returns {@link EMEmvTipOrConvenienceIndicator}.

Declared In

EMEmvTransactionInfo.h

– tipOrConvenienceValue required method

Provides value of tip.

This parameter is optional.

- (EMEmvOptional<NSNumber*> *)tipOrConvenienceValue

Return Value

Returns Tip or Convenience value as {@link NSNumber}.

Declared In

EMEmvTransactionInfo.h

– additionalDataFieldTemplate required method

Indicates optional parameters as additional data, that could be present in transaction object.

- (EMEmvOptional<id<EMEmvAdditionalDataFieldTemplate> > *)additionalDataFieldTemplate

Return Value

Returns {@link EMEmvAdditionalDataFieldTemplate} object in {@link EMEmvOptional}.

Declared In

EMEmvTransactionInfo.h

– emvRfuDataObjects required method

Indicates data reserved for future use.

- (NSArray<id<EMEmvDataObject> > *)emvRfuDataObjects

Return Value

Returns list of {@link EMEmvPrimitive} data objects reserved for future use of EMV or empty list of none are in the QR code.

Declared In

EMEmvTransactionInfo.h

– unreservedTemplates required method

Provides list of unreserved templates.

- (NSArray<id<EMEmvTemplateWithGui> > *)unreservedTemplates

Return Value

Returns list of {@link EMEmvTemplateWithGui} data objects that are unreserved or empty list of none are in the QR code.

Declared In

EMEmvTransactionInfo.h