Site Totals
Last updated: 04-Dec-2024
This command runs the End of Day Site Totals report. Site totals is the request/response sequence for getting totals for all the devices associated with that site.
- This command is NOT supported as of this publication.
- The host/gateway/integrator should support this command - First Data Rapid Connect as of this publication.
Note
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 | SITETOTALS | Command name |
| PITSTOP | Optional | Binary |
|
For PITSTOP solution, if this field is sent as TRUE, then the command will be sent to the host with the terminal ID (TID) of the PITSTOP device. If this is sent as empty or sent with FALSE value, then IPP terminal ID will be used. NOTE: As of this publication, this is applicable for FDRC. Also, this field is applicable only when ANYWHERECARDENABLED parameter (Device/PINPad Parameters) is enabled. Example: <PITSTOP>TRUE</PITSTOP>. |
||
| 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 |
Request packet Example
<TRANSACTION>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
<FUNCTION_TYPE>REPORT</FUNCTION_TYPE>
<COMMAND>SITETOTALS</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: Site Totals Request Successful | |
| 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: 100 | |
| HOST_RESPCODE | Numeric | Host response code. This will be sent if included in the SSI response. Example: 000 | |
| HOST_ADD_RESPTEXT | Character | Host response text. Example: Response returned by the host | |
| MAX_NUM_RECORDS_RETURNED | Numeric | Returns maximum number of records. Example: 5 | |
| NET_SETTLE_AMT | Floating point number | The exact amount of the merchant’s settlement for the business day being reported. Example: 1234.00 | |
| RECORDS | See RECORD below for elements. |
RECORD Child Elements
| Field | Type | Value(s) | Description |
|---|---|---|---|
| CARDTAG | Character | Returns the tag for the card. Example: CC | |
| ITEMCOUNT | Numeric | The total count of items. Example: 66 | |
| ITEMAMOUNT | Floating point number | The amount for the items. Example: 56.00 |
Response packet Example
<RESPONSE>
<RESPONSE_TEXT>Site Totals Request Successful</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<HOST_RESPCODE>000</HOST_RESPCODE>
<HOST_ADD_RESPTEXT>Response returned by the host</HOST_ADD_RESPTEXT>
<MAX_NUM_RECORDS_RETURNED>5</MAX_NUM_RECORDS_RETURNED>
<NET_SETTLE_AMT>1234.00</NET_SETTLE_AMT>
<RECORDS>
<RECORD>
<CARDTAG>CC</CARDTAG>
<ITEMCOUNT>56</ITEMCOUNT>
<ITEMAMOUNT>56.00</ITEMAMOUNT>
</RECORD>
<RECORD>
<CARDTAG>TE</CARDTAG>
<ITEMCOUNT>25</ITEMCOUNT>
<ITEMAMOUNT>-2.00</ITEMAMOUNT>
</RECORD>
<RECORD>
<CARDTAG>DS</CARDTAG>
<ITEMCOUNT>5</ITEMCOUNT>
<ITEMAMOUNT>10.00</ITEMAMOUNT>
</RECORD>
<RECORD>
<CARDTAG>DB</CARDTAG>
<ITEMCOUNT>10</ITEMCOUNT>
<ITEMAMOUNT>55.00</ITEMAMOUNT>
</RECORD>
<RECORD>
<CARDTAG>SV2</CARDTAG>
<ITEMCOUNT>25</ITEMCOUNT>
<ITEMAMOUNT>20.00</ITEMAMOUNT>
</RECORD>
</RECORDS>
</RESPONSE>
Rate this article:
