Batch History Report
Last updated: 04-Dec-2024
This command runs the batch history report. The BATCH_HISTORY report is the request/response sequence for a series of settlement summaries by date.
Note
For First Data Rapid Connect (FDRC), the report is limited in records by batchhistorylimit parameter. As of this publication, FDRC response may vary slightly from example.
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 |
|
|
| 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: 10 | |
| 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>10</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
<FUNCTION_TYPE>REPORT</FUNCTION_TYPE>
<COMMAND>BATCH_HISTORY</COMMAND>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: REPORT COMPLETE | |
| FUNCTION_TYPE | Character | REPORT |
|
| COMMAND | Character | OPEN_TABS_REPORT |
|
| 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: 1 | |
| BATCH_HISTORY_DATA/BATCH_HISTORY_DETAILS (FDRC) | Refer to the response example below to have more understandings on BATCH_HISTORY_DATA Receipt Text Elements. |
Note
For FDRC users, the Batch History Report will include summary information (transaction type and amount) for each batch as allowed by batchhistorylimit.
Response packet Example
<RESPONSE>
<RESPONSE_TEXT>Report Completed</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<BATCH_HISTORY_DATA>
<BATCH_HISTORY_DATA>
<TEXTLINE> VERIFONE SCA </TEXTLINE>
<TEXTLINE> 11700 Great Oaks Way </TEXTLINE>
<TEXTLINE> Suite 210 </TEXTLINE>
<TEXTLINE> Alpharetta </TEXTLINE>
<TEXTLINE> GA 30022 </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> 08/16/18 22:33:48 </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> Batch History Report </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> 08/16/18 22:05:43 </TEXTLINE>
<TEXTLINE> Batch Num: 1 </TEXTLINE>
<TEXTLINE> Host Name: TSYS </TEXTLINE>
<TEXTLINE> Merchant: 123000001005 </TEXTLINE>
<TEXTLINE> Sales: 1 $ 8.76 </TEXTLINE>
<TEXTLINE>**Refunds:**0***********$ 0.00**********</TEXTLINE>
<TEXTLINE> Total: 1 $ 8.76 </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> APPROVED </TEXTLINE>
<TEXTLINE> ACCEPTED </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
<TEXTLINE> </TEXTLINE>
</BATCH_HISTORY_DATA>
</BATCH_HISTORY_DATA>
</RESPONSE>
Rate this article:
