The business date you want to close a batch 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 close a batch.
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
Bodyapplication/jsonrequiredRefers 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
The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).
Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
Indicates whether or not you want the batch to include transactions for every day leading up to the transaction.businessDate.
| Value | Description |
|---|---|
| Y | The batch will contain transactions for every day leading up to the specified businessDate |
| N | The batch will contain transactions for only the specified businessDate |
Enum"Y""N"
The net amount that is expected to be in the batch (sales MINUS refunds). If this field is sent and the amount does not match, an error will be returned, and the batch will not be closed.
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/batches/submit
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/batches/submit
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "dateTime": "2024-05-21T09:18:23.283-07:00", "transaction": { "businessDate": "2021-04-15T00:00:00.000-07:00" }, "batch": { "inclusive": "N", "netAmount": 5601.78, "netCount": 187 } }
Response
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, "processors": [ … ] }, "merchant": { "mid": 15877, "name": "Merchant XYZ" }, "transaction": { "businessDate": "2021-04-15" }, "server": { "name": "TM01CE" } } ] }