EMEmvTransactionInfo

Objective-C

@protocol EMEmvTransactionInfo <NSObject>

Swift

protocol EMEmvTransactionInfo : NSObjectProtocol

Holds consolidated information about payment transaction.

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

    Declaration

    Objective-C

    - (Byte)payloadFormatIndicator;

    Swift

    func payloadFormatIndicator() -> UInt8

    Return Value

    Returns Payload Format Indicator as byte.

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

    Declaration

    Objective-C

    - (EMEmvPointOfInitiationMethod)pointOfInitiationMethod;

    Swift

    func pointOfInitiationMethod() -> EMEmvPointOfInitiationMethod

    Return Value

    Point of Initiation Method value as enum EMEmvPointOfInitiationMethod value. If the data object is not presents returns EMEmvPointOfInitiationMethod.EMEmvPointOfInitiationMethodUndefined.

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

    Declaration

    Objective-C

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

    Swift

    func merchantAccountInfo() -> [any EMEmvDataObject]!

    Return Value

    Returns list of EMEmvDataObject defining merchant account information. The list contains either instances of EMEmvPrimitive or EMEmvTemplateWithGui and -[EMEmvDataObject type] method should be used to distinguish them.

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

    Declaration

    Objective-C

    - (NSInteger)merchantCategoryCode;

    Swift

    func merchantCategoryCode() -> Int

    Return Value

    Returns numeric merchant category code as NSInteger.

  • 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.

    Declaration

    Objective-C

    - (NSString *)merchantName;

    Swift

    func merchantName() -> String!

    Return Value

    Returns merchant name as string.

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

    Declaration

    Objective-C

    - (NSString *)merchantCity;

    Swift

    func merchantCity() -> String!

    Return Value

    Returns merchant city as string.

  • 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.

    Declaration

    Objective-C

    - (NSString *)countryCode;

    Swift

    func countryCode() -> String!

    Return Value

    Returns country code as string.

  • 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.

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)postalCode;

    Swift

    func postalCode() -> EMEmvOptional<NSString>!

    Return Value

    Returns postal code as string in EMEmvOptional.

  • 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.

    Declaration

    Objective-C

    - (EMEmvOptional<NSNumber *> *)transactionAmount;

    Swift

    func transactionAmount() -> EMEmvOptional<NSNumber>!

    Return Value

    Returns transaction amount as NSNumber in EMEmvOptional.

  • 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.

    Declaration

    Objective-C

    - (NSInteger)currency;

    Swift

    func currency() -> Int

    Return Value

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

  • 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.

    Declaration

    Objective-C

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

    Swift

    func merchantInformationLanguageTemplate() -> EMEmvOptional<any EMEmvMerchantInformationLanguageTemplate>!

  • 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.

    Declaration

    Objective-C

    - (EMEmvTipOrConvenienceIndicator)tipOrConvenienceIndicator;

    Swift

    func tipOrConvenienceIndicator() -> EMEmvTipOrConvenienceIndicator

    Return Value

    Returns EMEmvTipOrConvenienceIndicator.

  • Provides value of tip.

    This parameter is optional.

    Declaration

    Objective-C

    - (EMEmvOptional<NSNumber *> *)tipOrConvenienceValue;

    Swift

    func tipOrConvenienceValue() -> EMEmvOptional<NSNumber>!

    Return Value

    Returns Tip or Convenience value as NSNumber.

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

    Declaration

    Objective-C

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

    Swift

    func additionalDataFieldTemplate() -> EMEmvOptional<any EMEmvAdditionalDataFieldTemplate>!

    Return Value

    Returns EMEmvAdditionalDataFieldTemplate object in EMEmvOptional.

  • Indicates data reserved for future use.

    Declaration

    Objective-C

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

    Swift

    func emvRfuDataObjects() -> [any EMEmvDataObject]!

    Return Value

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

  • Provides list of unreserved templates.

    Declaration

    Objective-C

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

    Swift

    func unreservedTemplates() -> [any EMEmvTemplateWithGui]!

    Return Value

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