REMOVE
Last updated: 04-Dec-2024
This command removes line item(s) or ‘offer’(s).
Device UI Required: Yes
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | LINE_ITEM | Type of function |
| COMMAND | Required | Static value | N/A | N/A | REMOVE | Command name |
| LINE_ITEM_ID | Required | Numeric | 1 | 10 | Line item ID for the item/offer. NOTE: It can be a required field if one line item is needed to remove. Removing more than one line items, will be requested in MERCHANDISE Child Elements and OFFER Child Elements section in LINE_ITEM_ID as a required field. Example: 1 | |
| RUNNING_SUB_TOTAL | Optional | Floating point number | 1(2) | 6(2) | Running subtotal. This field supports negative amounts. Example: 0.00 | |
| RUNNING_TAX_AMOUNT | Optional | Floating point number | 1(2) | 6(2) | Running tax total of the transaction. This field supports negative amounts. Example: 0.00 | |
| RUNNING_TRANS_AMOUNT | Required | Floating point number | 1(2) | 6(2) | Running total of the transaction. This field supports negative amounts. Example: 0.00 | |
| RUNNING_DISCOUNT_AMOUNT | Required | Floating point number | 1(2) | 6(2) | Discount amount. Example: -999999.99 | |
| COUNTER | Required | Numeric | 1 | 10 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. This is sed 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 |
MERCHANDISE Child Elements
Note
Remove single or multiple merchandise items.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| LINE_ITEM_ID | Required | Numeric | 1 | 10 | Ex: 1 | Line item identifier supplied by the POS. This must be unique to the payment transaction. Example: 1 |
OFFER Child Elements
Note
Remove single or multiple coupons/ discounts to merchandise.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| LINE_ITEM_ID | Required | Numeric | 1 | 10 | Line item identifier supplied by the POS. This must be unique to the payment transaction. Example: 1 |
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>LINE_ITEM</FUNCTION_TYPE>
<COMMAND>REMOVE</COMMAND>
<COUNTER>100</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
<LINE_ITEM_ID>1695155651</LINE_ITEM_ID>
<RUNNING_TRANS_AMOUNT>0.00</RUNNING_TRANS_AMOUNT>
<RUNNING_TAX_AMOUNT>0.00</RUNNING_TAX_AMOUNT>
</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 codes: -1, 59004, 59045 | 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. |
| 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>
<COUNTER>100</COUNTER>
</RESPONSE>
Rate this article:
