---
title: "Get current open transaction batch"
method: GET
path: "/rest/v1/batches/open"
tags: ["Batches - Batch out and Open Batches Query"]
---

# Get current open transaction batch

`GET /rest/v1/batches/open`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `api-key`
- TypeScript: <https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/rest/v1/batches/open/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the currently open batch on the gateway for the terminal.

## Response `200`

Success

- Batch
  - `id` string: Unique identifier of the open batch.
  - `status` string: Current status of the batch.
  - `settled` string: Indicates whether the batch has been settled.
  - `refund_count` string: Total number of refund transactions in the batch.
  - `refund_total` string: Total amount of refunds processed in the batch.
  - `sales_count` string: Total number of sales transactions in the batch.
  - `sales_total` string: Total amount of sales processed in the batch.
  - `net_amount` string: Net amount for the batch after sales and refunds are applied.
  - `total_count` string: Total number of transactions in the batch.
  - `confirmation_code` string: Confirmation code when the batch is opened or updated.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal server error

---

[API](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow.md) - [All operations](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/revisions/f37077c24b66?raw)