For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Interface Operation Complete

Notification 0x1805 - User Interface Operation Complete

This notification requests that the host take action during operations involving the device’s User Interface modules.

For this notification, Notification Detail described in Notification Message contains one byte each, shown in Table 350, to indicate:

  • The User Interface Module (UI) involved

  • The Reason (Rsn) for the notification (UI Event)

  • Detail (Det) about the notification that has different meanings depending on the Reason, and

  • An Extra field (Ext) that has different meanings depending on the Reason.

Table - Notification Detail Codes

Module 0x00 Miscellaneous contains UI notification detail codes that are not specific to a particular UI module.

UI

Rsn

Det

Ext

Meaning

Module 0x01 (Touchscreen only)

Module 0x01 Touchscreen contains UI notification detail codes that are specific to the touchscreen module (Touch Only).

  • Reason 0x01 = Signature Capture

  • Reason 0x02 = Functional button selected

  • Reason 0x03 = Button text string selected

  • Reason 0x04 = Button $Amount selected

  • Reason 0x05 = Present card functional button Right is selected

UI

Rsn

Det

Ext

Meaning

01

02

01

00

Touchscreen, Functional button Left selected

01

02

02

00

Touchscreen, Functional button Middle selected

01

02

03

00

Touchscreen, Functional button Right selected

01

03

01

00

Touchscreen, Text string button 1 selected

01

03

02

00

Touchscreen, Text string button 2 selected

01

03

03

00

Touchscreen, Text string button 3 selected

01

03

04

00

Touchscreen, Text string button 4 selected

01

03

05

00

Touchscreen, Text string button 5 selected

01

03

06

00

Touchscreen, Text string button 6 selected

01

04

00

00

Touchscreen, $Amount button selected, Data Attached contain the amount selected as described in Table - Notification Payload for $ Amount button selected, Data Attached

01

05

00

00

Touchscreen, Present card functional button Right selected

Module 0x02 (Display Only)

Module 0x02 Display contains UI notification detail codes that are specific to the display module. The device primarily uses these notifications to request that the host stand in as a display to interact with cardholders / operators when the device does not have a display of its own or the display is configured with Property 1.2.3.1.2.3 Send UI notifications along with showing message on the display.

  • Reason 0x01 = Display Message Request

  • Reason 0x02 = Cardholder Selection Request

UI

Rsn

Det

Ext

Meaning

02

01

00

00

Display, Display Message, No Data Attached, Clear Display.

The host should clear any existing messages it is currently displaying.

02

01

01

00

Display, Display Message, Data Attached, No Cancel Function

In this case, the notification includes additional data and display control, defined in Table - Notification Payload for Display Message Request Notifications, in the Notification Payload portion of the Notification Message.

This notification is for simple messages. The host should show the requested message until another notification arrives or until the host needs to use the display for its own purposes. For example, during a transaction, this notification will pass along the simple messages in the transaction sequence like CARD READ OK - REMOVE CARD , THANK YOU , and WELCOME .

02

01

02

00

Display, Display Message, Data Attached, Include Cancel Function

In this case, the notification includes additional data and display control, defined in Table - Notification Payload for Display Message Request Notifications, in the Notification Payload portion of the Notification Message.

The host should show the requested message and should allow the request to be canceled by a cardholder or operator. For example, during a transaction, this notification will pass along the simple messages in the transaction sequence like “TAP, INSERT, or SWIPE CARD,” where cancelation is appropriate. If the cancel button involves canceling the whole transaction, the host should send Command 0x1008 - Cancel Transaction.

02

02

00

00

Display, Cardholder Selection, Data Attached, Reserved

In this case, the notification includes additional data and display control, defined in

Table - Notification Payload for Cardholder Selection Notifications (No Display Only), in the Notification Payload portion of the Notification Message.

The host should show the requested selection, then send Command 0x1802 - Report Cardholder Selection to device to return the cardholder’s selection to the device.

Module 0x04 (Barcode Reader)

Module 0x04 Barcode Reader contains notification detail codes that are specific to the barcode reader module.

Reason 0x03 = Read Barcode Result

UI

Rsn

Det

Ext

Meaning

04

03

01

00

Barcode Reader, Read Barcode Result, Success, Unidentified Type

The barcode reader has successfully read a barcode. In this case, the device includes barcode data in the Notification Payload portion of the Notification Message. If the data is encrypted, the data is in the format described in Table 7.4‑5. Data that is not encrypted is in the format described in Table 7.4‑6.

04

03

01

01

Barcode Reader, Read Barcode Result, Success, MagTek Blob Type

The barcode reader has successfully read a barcode. In this case, the device includes barcode data in the Notification Payload portion of the Notification Message. MagTek Blob data is always encrypted. The data is in the format described in Table 7.4‑5.

04

03

01

02

Barcode Reader, Read Barcode Result, Success, EMV Type

The barcode reader has successfully read a barcode. In this case, the device includes barcode data in the Notification Payload portion of the Notification Message. EMV barcode data is always encrypted. The data is in the format described in Table 7.4‑5.

04

03

02

01

Barcode Reader, Read Barcode Result, Operation Failed, Timeout

Module 0x05 Buzzer

Module 0x05 Buzzer contains notification detail codes that are specific to the buzzer module.

Reason 0x04 = Buzzer Result

UI

Rsn

Det

Ext

Meaning

05

04

01

00

Buzzer, Buzzer Result, Operation Success, Reserve

05

04

02

00

Buzzer, Buzzer Result, Operation Fail, Reserve

Module 0x06 Card Emulation

Module 0x06 Card Emulation contains notification detail codes that are specific to card emulation.

Reason 0x05 = Card Emulation Result

UI

Rsn

Det

Ext

Meaning

06

05

01

00

Card Emulation, Card Emulation Result, Operation Success, Reserve

06

05

02

01

Card Emulation, Card Emulation Result, Operation Fail, Timeout

06

05

02

03

Card Emulation, Card Emulation Result, Operation Fail, Cancel

06

05

02

04

Card Emulation, Card Emulation Result, Operation Fail, Error

Module 0x07 LED

Module 0x07 LED contains notification detail codes that are specific to the LED module. • Reason 0x06 = LED Result

UI

Rsn

Det

Ext

Meaning

07

06

01

00

LED Result, LED 1 Operation, Success

07

06

01

01

LED Result, LED 1 Operation, Fail

07

06

02

03

LED Result, LED 2 Operation, Success

07

06

02

01

LED Result, LED 2 Operation, Fail

07

06

03

00

LED Result, LED 3 Operation, Success

07

06

03

01

LED Result, LED 3 Operation, Fail

07

06

04

00

LED Result, LED 4 Operation, Success

07

06

04

01

LED Result, LED 4 Operation, Fail

Table - Notification Payload for Barcode Reader, Read Barcode Result, Success (Encrypted Data Attached)

Tag

Len

Value/Description

Typ

Req

Default

Beginning of Notification Message

1805 = User Interface Operation Complete

84

var

Notification Payload

B

R

/DFDF59

var

Encrypted Data Primitive

Decrypt the value of this TLV data object using the algorithm and variant specified in the Encrypted Data KSN parameter and the Encrypted Data Encryption Type parameter to read its contents. The format of the decrypted data is shown in Table 7.4‑6.

B

R

/DFDF50

var

Encrypted Data KSN

B

R

/DFDF51

01

Encrypted Data Encryption Type

See section 4.4 Encryption Type for a list of valid values.

B

R

End of Notification Message

Table - Notification Payload for Barcode Reader, Read Barcode Result, Success (Unencrypted Data)

Tag

Len

Value / Description

Typ

Req

Default

FC

var

Barcode Data Container

T

R

/DF74

var

Barcode Data

B

O

Table – Default User Interface String IDs and Strings

Display String ID

Display String

0x0000

“ ”

0x0001

“Thank You”

0x0002

“Hello”

0x0003

“Please Select”

0x0004

“Touch Screen To Continue”

0x0005

“Cancel”

0x0006

“Select a Transaction”

0x0007

“Deposit”

0x0008

“Withdrawal”

0x0009

“Choose PIN”

0x000A

“Change PIN”

0x000B

“Balance”

0x000C

“Cash Advance”

0x000D

“Authenticate Me”

0x000E

“Transfer”

0x000F

“Make Payment”

0x0010

“On Sale”

0x0011

“Discount”

0x0012

“Clearance”

0x0013

“$5.00 /5 Mins.”

0x0014

“$6.00 /7 Mins.”

0x0015

“$7.00 /9 Mins.”

0x0016

“$8.00 /15 Mins.”

0x0017

“Call Attendant”

0x0018

“Print Receipt”

0x0019

“Email Receipt”

0x001A

“Text Receipt”

0x001B

“Please Select An Amount”

0x001C

“Please Select A Tip Amount”

0x001D

“Menu Selection 1”

0x001E

“Menu Selection 2”

0x001F

“Menu Selection 3”

0x0020

“Menu Selection 4”

0x0021

“Service Request”

0x0022

“Show More”

0x0023

“Options”

0x0024

“What is the issue?”

0x0025

“Exit”

0x0026

“No Hot Water”

0x0027

“Doesn't Spin”

0x0028

“Water Leakage”

0x0029

“No Heat”

0x002A

“Please select a Machine”

0x002B

“Pump 1”

0x002C

“Pump 2”

0x002D

“Pump 3”

0x002E

“Pump 4”

0x002F

“A1”

0x0030

“A2”

0x0031

“A3”

0x0032

“A4”

0x0033

“B1”

0x0034

“B2”

0x0035

“B3”

0x0036

“B4”

0x0037

“C1”

0x0038

“C2”

0x0039

“C3”

0x003A

“C4”

0x003B

“$5.50 – Cake”

0x003C

“$5.00 – Muffin”

0x003D

“$6.50 – Croissant”

0x003E

“$4.50 – Danish”

0x003F

“Req. QR Code”

0x0040

“Scan QR Code”

0x0041

“Scan NFC”

0x0042

“Call Server”

0x0043

“Request Bill”

0x0044

“Approve”

0x0045

“Reject”

0x0046

“Verify SMS”

0x0047

“Verify Email”

0x0048

“English”

0x0049

“Spanish”

0x0080

“Hola”

0x0081

“Por Favor Seleccione”

0x0082

“Toca Para Continuar”

0x0083

“Cancelar”

0x0084

“Seleccione Una Transaccion”

0x0085

“Deposito”

0x0086

“Retiro”

0x0087

“Elija PIN”

0x0088

“Cambiar PIN”

0x0089

“Adelanto En Efectivo”

0x008A

“Autenticarme”

0x008B

“Verificar SMS”

0x008C

“Confirmar”

0x008D

“Mostrar Mas”

0x008E

“Opciones”

0x008F

“Salida”

0x0090

“Transferir”

0x0091

“Realizar Pago”

0x0092

“En Venta”

0x0093

“Descuento”

0x0094

“Autorizacion”

0x0095

“Operador De Llamada”

0x0096

“Imprimir Recibo”

0x0097

“Correo Electronico”

0x0098

“Recibo De Texto”

0x0099

“Seleccione Una Cantidad”

0x009A

“Anadir Un Consejo”

0x009B

“Requerido Codigo QR”

0x009C

“Escanear Codigo QR”

0x009D

“Escanear NFC”

0x009E

“Servidor De Llamadas”

0x009F

“Solicitar Factura”

0x00A0

“Aprobar”

0x00A1

“Rechazar”

0x00A2

“Gracias”

0x00A3

“Ingles”

0x00A4

“Espanol”

String ID value can be from 0x0000 to 0x012B, and String length maximum is 30 characters. This default configured Strings can be changed and uploaded to the device

Last updated