com.gemalto.idp.mobile.qr.emv.transaction

Interface AdditionalDataFieldTemplate

All Superinterfaces:

DataObject, Template

public interface AdditionalDataFieldTemplate
extends Template

Interface providing additional data fields that could be present in the QR code.

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.gemalto.idp.mobile.qr.emv.transaction.DataObject

DataObject.Type

Method Summary

Modifier and Type	Method and Description
OptionalDO<java.lang.String>	getAdditionalConsumerDataRequest() Contains indications that the mobile application is to provide the requested information in order to complete the transaction.
OptionalDO<java.lang.String>	getBillNumber() Returns the invoice number or bill number, that could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a Bill Number.
OptionalDO<java.lang.String>	getCustomerLabel() Returns value identifying a specific consumer.
java.util.List<DataObject>	getEmvRfuDataObjects() Provides list of data objects reserved for future use of EMV.
OptionalDO<java.lang.String>	getLoyaltyNumber() Returns a loyalty card number.
OptionalDO<java.lang.String>	getMobileNumber() Returns the mobile number, that could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a Mobile Number.
java.util.List<DataObject>	getPaymentSystemSpecificTemplates() Provides list of Payment System specific templates.
OptionalDO<java.lang.String>	getPurposeOfTransaction() Returns value defining the purpose of the transaction.
OptionalDO<java.lang.String>	getReferenceLabel() Returns transaction identification value.
OptionalDO<java.lang.String>	getStoreLabel() Returns a distinctive value associated to a store.
OptionalDO<java.lang.String>	getTerminalLabel() Returns a distinctive value associated to a terminal in the store.

Methods inherited from interface com.gemalto.idp.mobile.qr.emv.transaction.Template

getDataObject, getDataObjectsWithinIdRange

Methods inherited from interface com.gemalto.idp.mobile.qr.emv.transaction.DataObject

getDataObjects, getId, getType, getValue

Method Detail

getBillNumber

OptionalDO<java.lang.String> getBillNumber()

Returns the invoice number or bill number, that could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a Bill Number.

For example, the Bill Number may be present when the QR Code is used for bill payment.

This parameter is optional.

Returns:

Bill number as string wrapped in OptionalDO.

getMobileNumber

OptionalDO<java.lang.String> getMobileNumber()

Returns the mobile number, that could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a Mobile Number.

For example, the Mobile Number to be used for multiple use cases, such as mobile top-up and bill payment.

This parameter is optional.

Returns:

Mobile number as string wrapped in OptionalDO.

getStoreLabel

OptionalDO<java.lang.String> getStoreLabel()

Returns a distinctive value associated to a store. This value could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a Store Label.

For example, the Store Label may be displayed to the consumer on the mobile application identifying a specific store.

This parameter is optional.

Returns:

Store label as string wrapped in OptionalDO.

getLoyaltyNumber

OptionalDO<java.lang.String> getLoyaltyNumber()

Returns a loyalty card number. This number could be provided by the merchant, if known, or could be an indication for the mobile application to prompt the consumer to input their Loyalty Number.

This parameter is optional.

Returns:

Loyalty number as string wrapped in OptionalDO.

getReferenceLabel

OptionalDO<java.lang.String> getReferenceLabel()

Returns transaction identification value. This value could be provided by the merchant or could be an indication for the mobile app to prompt the consumer to input a transaction Reference Label.

For example, the Reference Label may be used by the consumer mobile application for transaction logging or receipt display.

This parameter is optional.

Returns:

Reference label as string wrapped in OptionalDO.

getCustomerLabel

OptionalDO<java.lang.String> getCustomerLabel()

Returns value identifying a specific consumer. This value could be provided by the merchant (if known), or could be an indication for the mobile application to prompt the consumer to input their Customer Label.

For example, the Customer Label may be a subscriber ID for subscription services, a student enrolment number, etc.

This parameter is optional.

Returns:

Customer label as string wrapped in OptionalDO.

getTerminalLabel

OptionalDO<java.lang.String> getTerminalLabel()

Returns a distinctive value associated to a terminal in the store. This value could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a Terminal Label.

For example, the Terminal Label may be displayed to the consumer on the mobile application identifying a specific terminal.

This parameter is optional.

Returns:

Terminal label as string wrapped in OptionalDO.

getPurposeOfTransaction

OptionalDO<java.lang.String> getPurposeOfTransaction()

Returns value defining the purpose of the transaction. This value could be provided by the merchant or could be an indication for the mobile application to prompt the consumer to input a value describing the purpose of the transaction.

For example, the Purpose of Transaction may have the value "International Data Package" for display on the mobile application.

This parameter is optional.

Returns:

Purpose of transaction as string wrapped in OptionalDO.

getAdditionalConsumerDataRequest

OptionalDO<java.lang.String> getAdditionalConsumerDataRequest()

Contains indications that the mobile application is to provide the requested information in order to complete the transaction. The information requested should be provided by the mobile application in the authorization without unnecessarily prompting the consumer.

For example, the Additional Consumer Data Request may indicate that the consumer mobile number is required to complete the transaction, in which case the mobile application should be able to provide this number (that the mobile application has previously stored) without unnecessarily prompting the consumer.

This parameter is optional.

Returns:

Additional consumer data request as string wrapped in OptionalDO.

getEmvRfuDataObjects

java.util.List<DataObject> getEmvRfuDataObjects()

Provides list of data objects reserved for future use of EMV.

Returns:

List of DataObject or empty list if none are present in the QR code. Note: It is advised to use DataObject.getType() method to check concrete type and safely cast the list members.

getPaymentSystemSpecificTemplates

java.util.List<DataObject> getPaymentSystemSpecificTemplates()

Provides list of Payment System specific templates.

Returns:

List of DataObject or empty list if none are present in the QR code. Note: It is advised to use DataObject.getType() method to check concrete type and safely cast the list members.