Read the current batch-number state for a merchant + processor without issuing a value.
GET
/api/transactions/batch-sequence
deprecated
Requires: Transactions.Settlement.ManageBatchNumber, merchant scope.
**Required permissions**: `Transactions.Settlement.ManageBatchNumber` **Scope**: merchant
Parameters
| Name | In | Type | Description |
|---|---|---|---|
MerchantId
required |
query | string (uuid) | The merchant that owns the processor profile. |
ProcessorKey
required |
query | string | The processor key (e.g. `"tsys"`): the `ProcessorId` of the merchant's processor profile. Compared case-insensitively; the service lower-cases it before keying Redis to match settlement. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.