LANE CLOSED
Last updated: 04-Dec-2024
This command closes the active session. It also optionally displays a corresponding text message on the Idle screen.
Device UI Required: Yes
Request Packet
| Field | Rule | Type | Min | Max | Value | Comments |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static Value |
|
|
ADMIN | Type of function |
| COMMAND | Required | Static Value |
|
|
LANE_CLOSED | Command name |
| DISPLAY_TEXT | Optional | Character | 1 | 40 | Ex: Lane Closed | This field is used to display the text on the terminal. |
| FONT_COL_VALUE | Optional | Character | 6 | 6 | (Red) FF0000 (Green) 00FF00 (Blue) 0000FF (Black) 000000 |
Text color for lane closed display text (RGB hex color value). NOTE: If this field is sent then the values will be considered and if not sent then LANECLOSEDFONTCOL parameter values will take precedence. |
| FONT_SIZE | Optional | Numeric | 1 | 100 | Ex: 72 | Font size for display text. Maximum FONT_SIZE is dependent on Terminal used. 100 is the largest value possible assuming a large screen terminal. NOTE: If this field is sent then the values will be considered and if not sent then LANECLOSEDFONTSIZE parameter values will take precedence. |
| POS_RECON | Optional | Character | 1 | 30 | Ex: RetailPOS1 | POS reconciliation. NOTE: POS Reconciliation field to be echoed back in response to POS. |
| COUNTER | Required | Numeric | 1 | 10 | Ex: 8 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. NOTE: Used to authenticate the POS. |
| MAC | Required | Base64 Encoded Data |
|
|
Message Authentication Code. COUNTER value encrypted by 128-AES MAC_KEY. This value is Base64 encoded. NOTE: Used to authenticate the POS. |
|
| MAC_LABEL | Required | Character | 1 | 50 | Ex: REG1 | Associated label that tells the device which MAC_KEY to use to decrypt the value of MAC. NOTE: Used to authenticate the POS. |
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>ADMIN</FUNCTION_TYPE>
<COMMAND>LANE_CLOSED</COMMAND>
<DISPLAY_TEXT>Lane Closed</DISPLAY_TEXT>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
</TRANSACTION>
Response Packet
| Field | Type | Value | Comments |
|---|---|---|---|
| RESPONSE_TEXT | Character | Ex: Operation Successful | Processor response text. |
| RESULT | Character | Ex: OK | This indicates the Result details. |
| RESULT_CODE | Numeric | -1 59002 59005 59040 59043 59045 |
This indicates the result code. NOTE: Refer to Result/Error Codes section. |
| 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. |
| POS_RECON | Character | Ex: RetailPOS1 | POS reconciliation field echoed back if sent in request. |
| COUNTER | Numeric | Ex: 8 | Last counter used for the given MAC label. |
Example
<RESPONSE>
<RESPONSE_TEXT>Operation SUCCESSFUL</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<COUNTER>8</COUNTER>
</RESPONSE>
Rate this article:
