---
title: "Submit Batch"
method: POST
path: "/batches/submit"
tags: ["Batches"]
---

# Submit Batch

`POST /batches/submit`

This function is used to close a batch.

**Integration Methods:**
- Host Direct

See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

## Headers

- `InterfaceVersion` string, required
- `InterfaceName` string, required
- `CompanyName` string, required
- `AccessToken` string, uuid, required

## Request body

- object
  - `dateTime` string, ISO 8601, required — 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
  - `transaction` object, required
    - `businessDate` string, ISO 8601, required — The business date you want to close a batch for.
  - `batch` Batch, required
    - `inclusive` 'Y' | 'N', required — 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`
    - `netAmount` 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 the batch will not be closed.
    - `netCount` 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 not be closed.

## Response `200`

Request was processed

- object
  - `result` object[]
    - `dateTime` string, ISO 8601 — 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
    - `batch` BatchResponse
      - `inclusive` 'Y' | 'N' — Indicates whether or not the batch includes transactions for every day leading up to the business date. Value|Description -----|----------- Y | The batch includes transactions for every day leading up to the specified business date N | The batch includes transactions for only the specified business date
      - `netAmount` number — The net amount in the batch (saleAmount MINUS refundAmount)
      - `netCount` integer — The net transaction count in the batch (saleCount PLUS refundCount)
      - `refundAmount` number — The total amount of all refunds in the batch
      - `refundCount` integer — The count of all refunds in the batch
      - `saleAmount` number — The total amount of all sales in the batch
      - `saleCount` integer — The count of all sales in the batch
      - `processors` BatchProcessors[]
        - `archivesID` integer — The ID that was assigned to the closed batch.
        - `processor` string — The processor which handled this batch of transactions.
        - `currencyCode` string — The type of currency used for this batch of transactions.
        - `refundAmount` number — The total amount of all refunds in the batch
        - `refundCount` integer — The count of all refunds in the batch
        - `saleAmount` number — The total amount of all sales in the batch
        - `saleCount` integer — The count of all sales in the batch
    - `merchant` MerchantResponse
      - `mid` number — The merchant ID associated with the merchant account.
      - `name` string — The merchant’s business name as configured with Shift4.
    - `transaction` object
      - `businessDate` string, ISO 8601 — 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 the existing date. (yyyy-mm-dd)
    - `server` Server
      - `name` string — The name of the server that processed the request.

## Other responses

- `400` — Error
- `504` — Timeout

---

[API](https://skmtc.dev/shift4/apis/shift4-payment-api.md) · [All operations](https://skmtc.dev/shift4/apis/shift4-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shift4/shift4-payment-api/revisions/2f85c87cc9e5/schema)