DISPLAY_IMAGE
Last updated: 06-Jan-2025
This command will direct the device to render an on-demand full screen image using data sent by POS. The image will be displayed for a specified timeout period. Optionally, up to two buttons, Cancel and Ok (Accept), can be displayed beneath the image.
Device UI Required: Yes
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | DEVICE | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | DISPLAY_IMAGE | Command name |
| IMAGE_NAME | Optional | Character | 40 | Displays the image with the given name from the device. The image needs to be pre downloaded either using package or content download on the below device location: ‘/home/usr1/flash/www/’. If the file does not exist on the device, then POS will throw an error. The image name can be set as any name and the resolution is same as idle screen media resolution. This is applicable for VOS3 only. | ||
| IMAGE_DATA | Required | Base64 Encoded Data | Base64 encoded string (maximum 32,000) of JPG or PNG format to be converted to an image. This is an optional field if IMAGE_NAME is available. | |||
| IMAGE_TIMEOUT | Required | Numeric | 1 | 299 | The duration of time to display image, in seconds. New DISPLAY_IMAGE command would cancel current timer and start the new timer as it comes in the new command. Example: 30 | |
| DISPLAY_BUTTONS | Optional | Boolean | N/A | N/A |
|
Type of display buttons to be sent. |
| BUTTON_LABEL1 | Optional | Character | 1 | 15 | Text label to be displayed on the Cancel button. | |
| BUTTON_LABEL2 | Optional | Character | 1 | 15 | Text label to be displayed on the OK button. | |
| HIDE_CANCEL_BUTTON | Optional | Boolean | N/A | N/A |
|
This field is applicable when DISPLAY_BUTTONS field is set 1. |
| RETURN_SCREEN | Optional | List | N/A | N/A |
|
Indicates whether SCA should return to Idle Screen or remain on current Image if POS plans to send additional images. |
| POS_RECON | Optional | Character | 1 | 30 | POS reconciliation. POS Reconciliation field to be echoed back in response to POS. Example: RetailPOS1 | |
| COUNTER | Required | Numeric | 1 | 10 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. This is used to authenticate the POS. Example: 100 | |
| MAC | Required | Base64 Encoded Data | N/A | N/A | N/A | Message Authentication Code. This is used to authenticate the POS. |
| MAC_LABEL | Required | Character | 1 | 50 | Associated label that tells the device which MAC_KEY to use to decrypt the value of MAC. This is used to authenticate the POS. Example: REG1 |
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>DISPLAY_IMAGE</COMMAND>
<IMAGE_DATA>Base64 encoded string</IMAGE_DATA>
<IMAGE_TIMEOUT>30</IMAGE_TIMEOUT>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: Image Details Captured | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1 , 59001, 59040, 59042, 59043, 59049 | This indicates the result code. Refer to Result/Error Codes for details. |
| TERMINATION_STATUS | Character | SUCCESS or FAILURE | This indicates the transaction termination status. This is the overall status of the transaction irrespective of approved or declined. Like, if the output is generated then the status is SUCCESS and if no output is generated then the status will be FAILURE. |
| TIMEOUT_RESULT | Character |
|
Return the timeout result with value mentioned in Value column. Not included in response for Classic implementation as of this publication. |
| CUST_BUTTON_DATA | Character |
|
Represents button selected information for Cancel and OK. |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 |
Note
By default, the buttons will appear with OK and Cancel labels, and buttons will contain the label on them.
Example
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>Image Details Captured</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<CUST_BUTTON_DATA>2</CUST_BUTTON_DATA>
<COUNTER>1</COUNTER>
</RESPONSE>
Rate this article:
