The business date you want to obtain the totals report for.
Shift4 Payment API (1.7.43)
Overview
Languages
Servers
Host Direct Test URL
https://api.shift4test.com/api/rest/v1/
Host Direct Production URL
https://api.shift4api.net/api/rest/v1/
Request
This function is used to request a simple totals report for automated analysis. It does not supersede the standard auditing and reporting tools that are included with Shift4’ products.
Note: The GET request does not support a request body. Sending an empty request body may result in an error.
Integration Methods:
- Host Direct
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Security
AccessToken
Headers
Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =
Example: 2.1
Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =
Example: ForwardPOS
Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =
Example: PAWS
A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.
Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/reports/batchtotals
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/reports/batchtotals
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "result": [ { "dateTime": "2024-05-21T09:18:23.283-07:00", "batch": { "inclusive": "N", "netAmount": 5601.78, "netCount": 187, "refundAmount": 100, "refundCount": 1, "saleAmount": 5701.78, "saleCount": 186 }, "merchant": { "mid": 15877, "name": "Merchant XYZ" }, "server": { "name": "TM01CE" }, "transaction": { "businessDate": "2021-04-15" } } ] }