Skip to content

restApi Next version -> batchNum Optional #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexdll31 merged 1 commit into from
Apr 30, 2026
Merged

restApi Next version -> batchNum Optional #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions restapi/restendpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1737,7 +1737,7 @@ daily settlement batches per terminal).

Cloud API currently supports the following batch operations:

- `POST /batch/close` — requests the **closure of a batch** for a given terminal (`deviceType`, `serialNumber`) and `batchNumber`.
- `POST /batch/close` — requests the **closure of a batch** for a given terminal (`deviceType`, `serialNumber`).
- `POST /batch/summary` — retrieves a **summary of a batch** for a given terminal (`deviceType`, `serialNumber`) and `batchNumber`.
- `POST /batch/detail` — retrieves **batch detail** (including a list of transactions) for a given terminal (`deviceType`, `serialNumber`) and `batchNumber` (and optional `rrn`).

Expand All @@ -1755,7 +1755,7 @@ In MOTO scenarios, the `deviceType` and `serialNumber` fields can refer to a **v
`BatchClose`

`POST /batch/close` is used to request **closure of a batch** for a specific payment terminal, identified by its
`deviceType` and `serialNumber`, and a `batchNumber`.
`deviceType` and `serialNumber`, and optionally a `batchNumber`.

Typical use cases:

Expand All @@ -1773,15 +1773,15 @@ Typical fields in the request body (see [BatchCloseRequest](restobjects#batchClo

- `deviceType` <span class="badge badge--primary">Required</span> – Terminal model identifier (for example, `"PAXA920MAX"`).
- `serialNumber` <span class="badge badge--primary">Required</span> – Serial number of the payment terminal (for example, `"2740013262"`).
- `batchNumber` <span class="badge badge--primary">Required</span> – Identifier of the batch to close (for example, `"1"`).
- `batchNumber` <span class="badge badge--secondary">Optional</span> – Identifier of the batch to close (for example, `"1"`), if not specified, the current open batch for that Terminal will be closed.

#### Returns

| Result | Notes |
| ------ | ----- |
| `200` | Batch close request accepted. The response body is a [BatchCloseResponse](restobjects#batchCloseResponse) with the batch number, a unique `closeBatchGuid`, timestamps and an issuer-style response code/text. |
| `400` | Business rule error or generic gateway error. Returned as `BadRequestError`, with `error.code`, `error.message` and `error.details` describing the problem. |
| `422` | Payload validation error (`VALIDATION_FAILED`) when required fields are missing or do not match the schema (for example, missing `batchNumber`). |
| `422` | Payload validation error (`VALIDATION_FAILED`) when required fields are missing or do not match the schema (for example, missing `serialNumber`). |
| `5xx` | Internal error or service unavailability. The final outcome of the batch close may be unknown and may require reconciliation or a retry at a later time. |

**Code Example**
Expand Down
Loading