Skip to main content

SCA Functional Specification

IRS Tip Report

Last updated: 04-Dec-2024

This command runs the IRS Tip Report, summing up all tips for a given clerk/server. It will also allow the input of cash tip amount so a grand total can be printed.

  

Note

This is available for First Data Rapid Connect at time of publication. Generated from local batch file – no communication with host needed.

Device UI Required: No

Request Packet
Field Rule Type Minimum Maximum Value(s) Description
FUNCTION_TYPE Required Static value N/A N/A REPORT Type of function
COMMAND Required Static value N/A N/A IRS_TIP_REPORT Command name
CLERK_ID Required Numeric 1 3   If this field is sent, then the report will be generated only for that specified clerk/server. Example: 3
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: 9
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
Request packet Example
<TRANSACTION>
<FUNCTION_TYPE>REPORT</FUNCTION_TYPE>
<COMMAND>IRS_TIP_REPORT</COMMAND>
<CLERK_ID>1</CLERK_ID>
</TRANSACTION>
Response Packet
Field Type Value Description
RESPONSE_TEXT Character   Processor response text. Example: Report Completed
RESULT Character   This indicates the Result details. Example: OK
RESULT_CODE Numeric Expected result codes: -1 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: 9
FUNCTION_TYPE Character REPORT Returns the type of function.
COMMAND Character IRS_TIP_REPORT Returns the command name.
IRS_TIP_DATA     Refer to the response example below to have more understandings on IRS_TIP_DATA Receipt Text Elements.
Response packet Example
  

Note

Many TEXTLINE rows have been intentionally deleted from this example for the sake of space.

<RESPONSE>
<RESPONSE_TEXT>Report Completed</RESPONSE_TEXT>
<COMMAND>IRS_TIP_REPORT</COMMAND>
<FUNCTION_TYPE>REPORT</FUNCTION_TYPE>
<COUNTER>9</COUNTER>
<IRS_TIP_DATA>
        <IRS_TIP_DATA>
                <TEXTLINE>             VERIFONE SCA               </TEXTLINE>
                <TEXTLINE>         11700 Great Oaks Way           </TEXTLINE>
                <TEXTLINE>              Suite 210                 </TEXTLINE>
                <TEXTLINE>         Alpharetta, GA 30022           </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>Merchant ID: RCTST0000042337            </TEXTLINE>
                <TEXTLINE>Terminal ID: 005                        </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE>02/01/18                      16:56:55  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>            IRS TIP REPORT              </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />

                <TEXTLINE />
                <TEXTLINE>             Clerk ID:1                 </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE>      Tipped Sale Amt:         $ 14.00  </TEXTLINE>
                <TEXTLINE>              Tip Amt:          $ 2.00  </TEXTLINE>
                <TEXTLINE>          Tip Percent:          14.28%  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>         Cash Tip Amt:          $ 0.00  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE>            Total Tip:          $ 2.00  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />

                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
        </IRS_TIP_DATA>
</IRS_TIP_DATA>
<RECEIPT_DATA>
        <RECEIPT>
                <TEXTLINE>             VERIFONE SCA               </TEXTLINE>
                <TEXTLINE>         11700 Great Oaks Way           </TEXTLINE>
                <TEXTLINE>              Suite 210                 </TEXTLINE>
                <TEXTLINE>         Alpharetta, GA 30022           </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>Merchant ID: RCTST0000042337            </TEXTLINE>
                <TEXTLINE>Terminal ID: 005                        </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE>02/01/18                      16:56:55  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>            IRS TIP REPORT              </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>             Clerk ID:1                 </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE>      Tipped Sale Amt:         $ 14.00  </TEXTLINE>
                <TEXTLINE>              Tip Amt:          $ 2.00  </TEXTLINE>
                <TEXTLINE>          Tip Percent:          14.28%  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>         Cash Tip Amt:          $ 0.00  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE>            Total Tip:          $ 2.00  </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE>X                                       </TEXTLINE>
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
                <TEXTLINE />
        </RECEIPT>
</RECEIPT_DATA>
</RESPONSE>

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Verifone logo