How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Shift4

Shift4 Batches API

The Batches API from Shift4 — 1 operation(s) for batches.

Documentation Provider Profile APIs.io OpenAPI GitHub

Shift4 Batches API is one of 21 APIs that Shift4 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Batches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.7.57.

Requests are made against 2 base URLs: https://api.shift4test.com/api/rest/v1, https://api.shift4api.net/api/rest/v1.

1 operations 1 paths 33 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.7.57
Base URL
https://api.shift4api.net/api/rest/v1
Authentication
API Key, HTTP Hmac-Sha256
Contact
https://www.shift4.com/contact-us/
Resource Areas
1

Authentication & Security 2

Shift4 Batches API declares 2 security schemes for authenticating requests. An API key is passed in the header as AccessToken (AccessToken). It uses HTTP hmac-sha256 authentication (HMAC-SHA256).

  • AccessToken — A security credential used to authenticate API requests and all [i4Go®](https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20re…
  • HMAC-SHA256 — Authentication using HMAC-256 signatures as the authorization scheme. Sent in the Authorization header in the following format: Authorization: HMAC-SHA256 Cred…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Batches 1
POST
/batches/submit
Submit Batch
batchessubmit 4 params body → 200400504

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are BatchResponse (8 properties), BatchProcessors (7 properties), Error (6 properties), Batch (3 properties). Each schema is shown below with its type and property counts.

Batch
object
3 properties 1 required
MerchantMID
number
The merchant ID associated with the merchant account.
BatchNetAmountResponse
number
The net amount in the batch (saleAmount MINUS refundAmount)
BatchRefundCount
integer
The count of all refunds in the batch
BatchNetAmount
number
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 t…
Error
object
6 properties
ServerName
string
The name of the server that processed the request.
MerchantName
string
The merchant’s business name as configured with Shift4.
BatchNetCountResponse
integer
The net transaction count in the batch (saleCount PLUS refundCount)
MerchantResponse
object
2 properties
BatchProcessorsCurrencyCode
string
The type of currency used for this batch of transactions.
BatchProcessorsProcessor
string
The processor which handled this batch of transactions.
BatchInclusiveResponse
string
Indicates whether or not the batch includes transactions for every day leading up to the business date. Value|Description -----|----------- Y | The batch inclu…
BatchNetCount
integer
The net transaction count in the batch (sales PLUS refunds). If this field is sent and the count does not match, an error will be returned, and the batch will…
ErrorSeverity
string
Severity level of the error. | Severity | Description | | -------- | ---------------------------------------------------------------- | | Info | Action not req…
BatchProcessorsArray
array
TransactionBusinessDate
string
Desired business date of a transaction. Include when overriding the existing business date of a transaction. The overriding date may be earlier or later than t…
BatchInclusive
string
Indicates whether or not you want the batch to include transactions for every day leading up to the transaction.businessDate. Value|Description -----|---------…
DateTime
string
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 ex…
ErrorLongText
string
Extended error message that is returned if an error condition exists.
BatchResponse
object
8 properties
BatchProcessors
object
7 properties
ErrorShortText
string
Abbreviated error message that is always returned if an error condition exists
SubmitBatchBusinessDate
string
The business date you want to close a batch for.
LighthouseDataResponse
string
Base64 encoded JSON formatted data that will be returned from Lighthouse to be passed back to SkyTab. This data will contain variable information.
ErrorPrimaryCode
integer
Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.
BatchRefundAmount
number
The total amount of all refunds in the batch
BatchSaleCount
integer
The count of all sales in the batch
BatchSaleAmount
number
The total amount of all sales in the batch
ErrorCode
integer
Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details. Note: Th…
ErrorSecondaryCode
integer
This code supplements the code specified in the error.primaryCode field to provide additional information about the error that occurred.
Server
object
1 property
BatchProcessorsArchivesId
integer
The ID that was assigned to the closed batch.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shift4-batches-api-openapi.yml Raw ↑

Other APIs Shift4 publishes across the network.

Shift4 3D Secure API
AE Profile APIs.io
Shift4 ACH API
AE Profile APIs.io
Shift4 Cards API
AE Profile APIs.io
Shift4 Checkout Sessions API
AE Profile APIs.io
Shift4 Credentials API
AE Profile APIs.io
Shift4 DCC API
AE Profile APIs.io
Shift4 Devices API
AE Profile APIs.io
Shift4 Gift Cards API
AE Profile APIs.io
Shift4 Merchants API
AE Profile APIs.io
Shift4 Mode API
AE Profile APIs.io
Shift4 OCT API
AE Profile APIs.io
Shift4 Payment Links API
AE Profile APIs.io
#Batches
← Back to S APIs
API Details
ID
shift4:shift4-batches-api
Base URL
https://api.shift4api.net/api/rest/v1
Docs
https://docs.shift4.com/apis/payments-platform-rest/openapi
Provider
Shift4
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=shift4-batches-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/shift4-batches-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Shift4 Batches API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.