EmvTransactionInfo (Mobile Protector SDK Documentation (5.2.0))

```
public interface EmvTransactionInfo
```
Provides interface to obtain particular transaction data read from the QR code.

Since:

5.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OptionalDO<AdditionalDataFieldTemplate>`	`getAdditionalDataFieldTemplate()` Provides additional data fields, that could be present in the QR code
`java.lang.String`	`getCountryCode()` Indicates the country of the merchant acceptance device.
`java.util.List<DataObject>`	`getEmvRfuDataObjects()` Provides data reserved for future use.
`java.util.List<DataObject>`	`getMerchantAccountInfo()` Provides information about merchant's account.
`int`	`getMerchantCategoryCode()` Identifies merchant category code as defined by [ISO 18245] and assigned by the Acquirer.
`java.lang.String`	`getMerchantCity()` Identifies city of operations for the merchant.
`OptionalDO<MerchantInformationLanguageTemplate>`	`getMerchantInformationLanguageTemplate()` Provides language preference and Merchant Name-Alternate Language.
`java.lang.String`	`getMerchantName()` Identifies "doing business as" name for the merchant, recognizable to the consumer.
`byte`	`getPayloadFormatIndicator()` Defines the version of the QR Code template and hence the conventions on the identifiers, lengths, and values.
`PointOfInitiationMethod`	`getPointOfInitiationMethod()` Identifies the communication technology (here QR Code) and whether the data is static or dynamic.
`OptionalDO<java.lang.String>`	`getPostalCode()` Zip code or Pin code or Postal code of the merchant.
`TipOrConvenienceIndicator`	`getTipOrConvenienceIndicator()` 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.
`OptionalDO<java.math.BigDecimal>`	`getTipOrConvenienceValue()` Provides value of tip.
`OptionalDO<java.math.BigDecimal>`	`getTransactionAmount()` The transaction amount, if known.
`int`	`getTransactionCurrency()` Indicates the currency code of the transaction.
`java.util.List<TemplateWithGui>`	`getUnreservedTemplates()` Provides list of unreserved templates.

- Method Detail
  - getPayloadFormatIndicator
```
byte getPayloadFormatIndicator()
```
    Defines the version of the QR Code template and hence the conventions on the identifiers, lengths, and values.
    
    Returns:
    
    Payload Format Indicator value as byte.
  - getPointOfInitiationMethod
```
PointOfInitiationMethod getPointOfInitiationMethod()
```
    Identifies the communication technology (here QR Code) and whether the data is static or dynamic. This parameter is optional.
    
    Returns:
    
    Point of Initiation Method value as enum PointOfInitiationMethod value. If the data object is not presents returns PointOfInitiationMethod.UNDEFINED.
  - getMerchantAccountInfo
```
java.util.List<DataObject> getMerchantAccountInfo()
```
    Provides information about merchant's account. The format and value are specific to a payment system.
    
    Returns:
    
    List of DataObject defining merchant account information. The list contains either instances of Primitive or TemplateWithGui and DataObject.getType() method should be used to distinguish them.
  - getMerchantCategoryCode
```
int getMerchantCategoryCode()
```
    Identifies merchant category code as defined by [ISO 18245] and assigned by the Acquirer.
    
    Returns:
    
    Numeric merchant category code as integer.
  - getMerchantName
```
java.lang.String getMerchantName()
```
    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.
    
    Returns:
    
    Merchant name as string.
  - getMerchantCity
```
java.lang.String getMerchantCity()
```
    Identifies city of operations for the merchant. This name may be displayed to the consumer by the mobile application when processing the transaction.
    
    Returns:
    
    Merchant city as string.
  - getCountryCode
```
java.lang.String getCountryCode()
```
    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.
    
    Returns:
    
    Country code as string.
  - getPostalCode
```
OptionalDO<java.lang.String> getPostalCode()
```
    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.
    
    Returns:
    
    Postal code as string wrapped in OptionalDO.
  - getTransactionAmount
```
OptionalDO<java.math.BigDecimal> getTransactionAmount()
```
    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.
    
    Returns:
    
    Transaction amount as BigDecimal in OptionalDO.
  - getTransactionCurrency
```
int getTransactionCurrency()
```
    Indicates the currency code of the transaction. This value should 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.
    
    Returns:
    
    A 3-digit numeric currency code, as defined by [ISO 4217].
  - getMerchantInformationLanguageTemplate
```
OptionalDO<MerchantInformationLanguageTemplate> getMerchantInformationLanguageTemplate()
```
    Provides language preference and Merchant Name-Alternate Language. It may contain the Merchant City-Alternate Language.
    This object is optional.
    
    Returns:
    
    MerchantInformationLanguageTemplate object wrapped in OptionalDO.
  - getTipOrConvenienceIndicator
```
TipOrConvenienceIndicator getTipOrConvenienceIndicator()
```
    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.
    
    Returns:
    
    Enumeration value from TipOrConvenienceIndicator.
  - getTipOrConvenienceValue
```
OptionalDO<java.math.BigDecimal> getTipOrConvenienceValue()
```
    Provides value of tip.
    This object is optional.
    
    Returns:
    
    Tip or Convenience value as BigDecimal.
  - getAdditionalDataFieldTemplate
```
OptionalDO<AdditionalDataFieldTemplate> getAdditionalDataFieldTemplate()
```
    Provides additional data fields, that could be present in the QR code
    This object is optional.
    
    Returns:
    
    AdditionalDataFieldTemplate object wrapped in OptionalDO.
  - getEmvRfuDataObjects
```
java.util.List<DataObject> getEmvRfuDataObjects()
```
    Provides data reserved for future use.
    
    Returns:
    
    List of Primitive data objects reserved for future use of EMV or empty list of none are in the QR code.
  - getUnreservedTemplates
```
java.util.List<TemplateWithGui> getUnreservedTemplates()
```
    Provides list of unreserved templates.
    
    Returns:
    
    List of TemplateWithGui data objects that are unreserved or empty list of none are in the QR code.

Interface EmvTransactionInfo

Method Summary

Method Detail

getPayloadFormatIndicator

getPointOfInitiationMethod

getMerchantAccountInfo

getMerchantCategoryCode

getMerchantName

getMerchantCity

getCountryCode

getPostalCode

getTransactionAmount

getTransactionCurrency

getMerchantInformationLanguageTemplate

getTipOrConvenienceIndicator

getTipOrConvenienceValue

getAdditionalDataFieldTemplate

getEmvRfuDataObjects

getUnreservedTemplates