APPLY UPDATES
Last updated: 04-Dec-2024
This command allows the POS to signal the device to immediately apply any pending updates from VHQ. SCA will inform VHQ to defer the updates if a transaction is in progress.
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 |
|
|
APPLYUPDATES | Command name |
| COUNTER | Required | Numeric | 1 | 10 | Ex: 100 | 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>APPLYUPDATES</COMMAND>
<FLAG>TRUE</FLAG>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
</TRANSACTION>
Response Packet
| Field | Type | Value | Comments |
|---|---|---|---|
| RESPONSE_TEXT | Character | Ex: Updates Approved | Processor response text |
| RESULT | Character | Ex: OK | This indicates the Result details. |
| RESULT_CODE | Numeric | -1 59002 59005 59040 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. |
| TIME | Character | Ex: 20160521122005 | Current time in YYYYMMDDhhmmss format. SCA is required to query and return the current date/time after it is set. |
| POS_RECON | Character | Ex: RetailPOS1 | POS reconciliation field echoed back if sent in request. |
| COUNTER | Numeric | Ex: 100 | Last counter used for the given MAC label. |
Example
<RESPONSE>
<RESPONSE_TEXT>SUCCESS</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<COUNTER>1</COUNTER>
</RESPONSE>
Rate this article:
