CANCEL
Last updated: 04-Dec-2024
This command cancels the transaction that is currently in progress. It does not cancel the session. Cancel notification will be supplied to the POS on the primary port.
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 | CANCEL | 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 | 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>CANCEL</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: SUCCESS. | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1, 59006, 59001, 59049 | This indicates the result code. |
| 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 cancelling the transaction. |
| DETAILED_STATUS | Numeric | Refer to Detailed Status Values for all the status codes and description. | Returns the status code. |
| 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>SUCCESS</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<SECONDARY_DATA>0</SECONDARY_DATA>
</RESPONSE>
Following is an example of response packet - Primary Port Response (Ongoing Transaction)
<RESPONSE>
<RESPONSE_TEXT>Cancelled by POS</RESPONSE_TEXT>
<RESULT>CANCELLED</RESULT>
<RESULT_CODE>59049</RESULT_CODE>
<TERMINATION_STATUS>FAILURE</TERMINATION_STATUS>
</RESPONSE>
Following is an example of response packet - Primary Port Response (No Transaction)
No Response
Following is an example of response packet - Primary Port Response (Transaction in Flight)
No Response
Rate this article:
