CUSTOMER_BUTTONS
Last updated: 04-Dec-2024
This command directs the device to display up to five (5) lines of display text and up to six (6) on screen button selections with corresponding labels.
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 | CUST_BUTTON | Command name |
DISPLAY_TEXT1 | Optional | Character | 1 | 45 | Displays text line 1. Example: PLEASE SELECT THE COMPANY | |
DISPLAY_TEXT2 | Optional | Character | 1 | 45 | Displays text line 2. Example: YOU HAVE WORKED | |
DISPLAY_TEXT3 | Optional | Character | 1 | 45 | Displays text line 3. Example: THROUGHOUT | |
DISPLAY_TEXT4 | Optional | Character | 1 | 45 | Displays text line 4. Example: YOUR | |
DISPLAY_TEXT5 | Optional | Character | 1 | 45 | Displays text line 5. Example: CAREER | |
BUTTON_LABEL1 | Optional | Character | 1 | 15 | Label for Button 1. Example: WORLD MARKETING | |
BUTTON_LABEL2 | Optional | Character | 1 | 15 | Label for Button 2. Example: VERIFONE | |
BUTTON_LABEL3 | Optional | Character | 1 | 15 | Label for Button 3. Example: FIRSTDATA | |
BUTTON_LABEL4 | Optional | Character | 1 | 15 | Label for Button 4. Example: TSYS | |
BUTTON_LABEL5 | Optional | Character | 1 | 15 | Label for Button 5. Example: WIPRO | |
BUTTON_LABEL6 | Optional | Character | 1 | 15 | Label for Button 6. Example: GIRMITI | |
RETURN_SCREEN | Optional | Character | 1 | 15 | Return screen. | |
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 |
|
44 | Message Authentication Code. This is used to authenticate the POS. Example: fK6w3AYFSWYC7IavAjcYZUgzOCZ3mPkRCPSYAnIk31Y= | |
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: P_AFV1IM |
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>CUST_BUTTON</COMMAND>
<DISPLAY_TEXT1>PLEASE SELECT THE COMPANY YOU HAVE WORKED IN.</DISPLAY_TEXT1>
<DISPLAY_TEXT2> YOUR CAREER</DISPLAY_TEXT2>
<DISPLAY_TEXT3>IN INDIA</DISPLAY_TEXT3>
<DISPLAY_TEXT4>.</DISPLAY_TEXT4>
<DISPLAY_TEXT5></DISPLAY_TEXT5>
<BUTTON_LABEL1>WORLD MARKETING</BUTTON_LABEL1>
<BUTTON_LABEL2>VERIFONE</BUTTON_LABEL2>
<BUTTON_LABEL3>FIRSTDATA</BUTTON_LABEL3>
<BUTTON_LABEL4>TSYS</BUTTON_LABEL4>
<BUTTON_LABEL5>WIPRO</BUTTON_LABEL5>
<BUTTON_LABEL6>GIRMITI</BUTTON_LABEL6>
</TRANSACTION>
Response Packet
Field | Type | Value | Description |
---|---|---|---|
RESPONSE_TEXT | Character | Processor response text. Example: Customer Button Captured | |
RESULT | Character | This indicates the Result details. Example: OK | |
RESULT_CODE | Numeric | Expected result code: -1, 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. |
CUST_BUTTON_DATA | Character | 1, 2, 3, 4, 5, 6 | Represents the button selected by the user. |
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>Customer Button Captured</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<CUST_BUTTON_DATA>5</CUST_BUTTON_DATA>
<COUNTER>1</COUNTER>
</RESPONSE>
Rate this article: