EMEmvAdditionalDataFieldTemplate

Objective-C

@protocol EMEmvAdditionalDataFieldTemplate <EMEmvTemplate>

Swift

protocol EMEmvAdditionalDataFieldTemplate : EMEmvTemplate

Holds additional data fields that could be present in the QR code. It provides a simple interface to retrieve value of such fields.

Since

5.0

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)billNumber;

    Swift

    func billNumber() -> EMEmvOptional<NSString>!

    Return Value

    Returns bill number as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)mobileNumber;

    Swift

    func mobileNumber() -> EMEmvOptional<NSString>!

    Return Value

    Returns mobile number as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)storeLabel;

    Swift

    func storeLabel() -> EMEmvOptional<NSString>!

    Return Value

    Returns store label as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)loyaltyNumber;

    Swift

    func loyaltyNumber() -> EMEmvOptional<NSString>!

    Return Value

    Returns Loyalty number as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)referenceLabel;

    Swift

    func referenceLabel() -> EMEmvOptional<NSString>!

    Return Value

    Returns reference label as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)customerLabel;

    Swift

    func customerLabel() -> EMEmvOptional<NSString>!

    Return Value

    Returns customer label as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)terminalLabel;

    Swift

    func terminalLabel() -> EMEmvOptional<NSString>!

    Return Value

    Returns Terminal label as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)purposeOfTransaction;

    Swift

    func purposeOfTransaction() -> EMEmvOptional<NSString>!

    Return Value

    Returns purpose of transaction as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

    - (EMEmvOptional<NSString *> *)additionalConsumerDataRequest;

    Swift

    func additionalConsumerDataRequest() -> EMEmvOptional<NSString>!

    Return Value

    Returns additional consumer data request as string wrapped in EMEmvOptional.

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

    Declaration

    Objective-C

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

    Swift

    func emvRfuDataObjects() -> [any EMEmvDataObject]!

    Return Value

    Returns list of EMEmvDataObject or empty list if none are present in the QR code. Note: It is advised to use -[EMEmvDataObject type] method to check concrete type and safely cast the list members.

  • Provides list of Payment System specific templates.

    Declaration

    Objective-C

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

    Swift

    func paymentSystemSpecificTemplates() -> [any EMEmvDataObject]!

    Return Value

    Returns list of EMEmvDataObject or empty list if none are present in the QR code. Note: It is advised to use -[EMEmvDataObject type] method to check concrete type and safely cast the list members.