LINE_ITEM_END
Last updated: 07-Apr-2025
This command is used for basket finalizing and sending the trigger to the CP apps on the device. This signifies the transition from line-item basket formation to the payment transaction.
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 | LINE_ITEM_END | Command name |
| CASH_PAYMENT | Optional | Boolean | N/A | N/A | TRUE or FALSE | Cash payment. In POS, default value is set as TRUE. |
| INVOICE | Optional | Character | 1 | 40 | Merchant invoice number. Maximum 40 characters (A-Z, a-z, 0-9) and these are not case sensitive. All the special characters are supported in INVOICE. POS, integrated with the application should handle maximum invoice applicable for the host used in the environment Vantiv allows numeric only; the value may not be all zeroes. Example: TA1234 | |
| LANE | Optional | Numeric | 1 | 8 | This field is used to identify the retail lane. Example: 1 | |
| NOTIFY_SCA_EVENTS | Optional | Boolean | N/A | N/A | TRUE or FALSE | If this field is set to TRUE, then it returns event broadcasts as play by play of what is occurring on the device when interacting with consumer and host as Unsolicited Consumer Selection response. This is applicable to Vantiv Direct Engage Devices Only (as of this publication). POS_IP and POS_PORT must be sent. Broadcast events should be used as information only and not as a condition for stopping or resuming a transaction. The exception would be in case where consumer interaction has lapsed for certain duration and POS elects to CANCEL on secondary port. |
| POS_IP | Optional | Character | This indicates the POS listening IP address. This is for Consumer Unsolicited responses to POS. Example: 192.168.31.100 | |||
| POS_PORT | Optional | Numeric | 4 | 4 | This indicates the POS listening port. This is for Consumer Unsolicited responses to POS. Example: 5016 | |
| STORE_NUM | Optional | Character | 1 | 6 | Store number. Example: 203 | |
| 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 sed 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>LINE_ITEM</FUNCTION_TYPE>
<COMMAND>LINE_ITEM_END</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, 59040 | 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. |
| CASH_PAYMENT | Boolean | TRUE or FALSE | This field is returned as sent in the request. |
| POS_RECON | Character | POS reconciliation field echoed back if sent in request. Example: RetailPOS1 | |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 |
Transaction Performance Metric
Note
These fields are returned, if SCAPERFMETRIC parameter (Application Parameters) is enabled.
| Field | Type | Value | Description |
|---|---|---|---|
| UI_TIME | Time | This indicates the time duration, for which the device screen is displayed (like error message, prompt screen, remove card screen) till any user action is performed in the command execution flow. This field is not applicable to capture the time for the Processing, Authorizing and transaction status screen. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <UI_TIME>44.028</UI_TIME> |
|
| HOST_TIME | Time | This indicates the time taken for the Connection to the host, sending request and receives data from the host. This field also take the cumulative time for multiple requests which may sent to the host during the transaction including two legged transactions, timeout requests, Auto Last Tran requests, DCC, Credit app proxy. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <HOST_TIME>1.389</HOST_TIME> |
|
| CMD_TIME | Time | This field indicates the total amount of time for a command, which is executed by the application from request received to the response sent. The format of the returned value would be S.sss, where S is seconds (this can be 0 to any positive integer) and sss is milliseconds. In case of any insignificant time or 0.000 value, will not be returned in the response. Example: <CMD_TIME>70.765</CMD_TIME> |
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>10</COUNTER>
</RESPONSE>
Rate this article:
