UPDATE STATUS
Last updated: 04-Dec-2024
This command will query the status of a VHQ update.
Note
This command is supported by Engage devices only.
Prerequisites: The terminal should be fully initialized on Idle screen.
Device UI Required: No
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | SECONDARYPORT | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | UPDATE_STATUS | Command name |
| 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 | 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>SECONDARYPORT</FUNCTION_TYPE>
<COMMAND>UPDATE_STATUS</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: Operation SUCCESSFUL | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1, 59006, 59001 | This indicates the result code. Refer to Result/Error Codes for details. |
| TERMINATION_STATUS | Character | SUCCESS and 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. |
| SECONDARY_DATA | Numeric |
|
This indicates the status of the secondary data upon sending the queries for VHQ updates. Refer to Secondary Data Values for all the secondary data value. |
| DETAILED_STATUS | Numeric | Refer to Detailed Status Values for all the status codes and description. | Returns the status code. |
| MACLABEL_IN_SESSION | Character | MACLABEL is in session. This is applicable when session is in progress. | |
| SESSION_DURATION | Character | The duration of the session. This is applicable when session is in progress. Example: HH:MM:SS | |
| INVOICE_SESSION | Character | Invoice number supplied by the POS Start Session for the session that is in progress. Only applicable when session is in progress. This field is applicable when session is in progress. Example: /06/2015 20:13: | |
| DEVICENAME | Character | This indicates the serial number of the terminal. Example: LANE1 | |
| SERIALNUMBER | Character | This indicates the serial number of the terminal. Example: 987654321 | |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 |
Example
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>Operation SUCCESSFUL</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<SECONDARY_DATA>0</SECONDARY_DATA>
<INVOICE_SESSION>/06/2015 20:13:</INVOICE_SESSION>
<SERIALNUMBER>987654321</SERIALNUMBER>
</RESPONSE>
Rate this article:
