CHECK_BOX
Last updated: 07-Apr-2025
This command is used to direct the device to display text along with up to six (6) labeled check boxes for the collection of consumer responses.
Device UI Required: Yes
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | DEVICE | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | CHECKBOX | Command name |
| DISPLAY_TEXT | Optional | Character | 1 | 200 | The length of text to be allowed to display. In this field, the text will be displayed in maximum of three lines on the terminal. After 67 characters, it will take the next line. Hence, it is recommended not to add new line on the POS request. Example: What factors are important to you when buying a Verifone product? | |
| CHECKBOX_LABEL1 | Optional | Character | 1 | 44 | Label for Check Box 1. Minimum one of check boxes should be labelled. Example: Price | |
| CHECKBOX_LABEL2 | Optional | Character | 1 | 44 | Label for Check Box 2. Minimum one of check boxes should be labelled. Example: Usability | |
| CHECKBOX_LABEL3 | Optional | Character | 1 | 44 | Label for Check Box 3. Minimum one of check boxes should be labelled. Example: Feature | |
| CHECKBOX_LABEL4 | Optional | Character | 1 | 44 | Label for Check Box 4. Minimum one of check boxes should be labelled. Example: Support | |
| CHECKBOX_LABEL5 | Optional | Character | 1 | 44 | Label for Check Box 5. Minimum one of check boxes should be labelled. Example: Software update | |
| CHECKBOX_LABEL6 | Optional | Character | 1 | 44 | Label for Check Box 6. Minimum one of check boxes should be labelled. Example: Services | |
| POS_RECON | Optional | Character | 1 | 30 | POS reconciliation. POS Reconciliation field to be echoed back in response to POS. Example: RetailPOS1 | |
| COUNTER | Optional | 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>DEVICE</FUNCTION_TYPE>
<COMMAND>CHECKBOX</COMMAND>
<DISPLAY_TEXT>What factors are important to you when buying a Verifone product?</DISPLAY_TEXT>
<CHECKBOX_LABEL1>Price</CHECKBOX_LABEL1>
<CHECKBOX_LABEL2>Usability</CHECKBOX_LABEL2>
<CHECKBOX_LABEL3>Features</CHECKBOX_LABEL3>
<CHECKBOX_LABEL4>Support</CHECKBOX_LABEL4>
<CHECKBOX_LABEL5>Software update</CHECKBOX_LABEL5>
<CHECKBOX_LABEL6>Services</CHECKBOX_LABEL6>
<POS_RECON>GET ECHO</POS_RECON>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: Checkbox Option(s) Captured | |
| RESULT | Character | This indicates the Result details. Example: OK | |
| RESULT_CODE | Numeric | Expected result code: -1, 59001, 59006, 59040 | This indicates the result code. Refer to Result/Error Codes for details. |
| 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. |
| CHECKBOX_N | Character | Y | For each CHECKBOX N selected, a CHECKBOX_n field will be returned indicating ‘Y’ for positive selection. For example, if checkboxes 2 and 5 are selected: CHECKBOX_2 = Y, CHECKBOX_5 = Y, POS_RECON (Example: 1234 POS reconciliation field) |
| 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>Checkbox Option(s) Captured</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<CHECKBOX_1>Y</CHECKBOX_1>
<CHECKBOX_2>Y</CHECKBOX_2>
<CHECKBOX_3>Y</CHECKBOX_3>
<CHECKBOX_4>Y</CHECKBOX_4>
<CHECKBOX_5>Y</CHECKBOX_5>
<CHECKBOX_6>Y</CHECKBOX_6>
<POS_RECON>GET ECHO</POS_RECON>
<COUNTER>1</COUNTER>
</RESPONSE>
Rate this article:
