Triggers asynchronous processing of a batch file.
POST
/api/transactions/batch-file/{id}/trigger-processing
deprecated
No permission required.
The batch file must be in `Ready` or `Pending` status. A distributed event is published to initiate the background processing workflow. Processing progress is reflected in the batch file's status and transaction counters.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id
required |
path | string (uuid) | The batch file ID to process. |
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 Processing triggered successfully.
Body: BatchFileDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
id
required |
string (uuid) | |
creationTime
required |
string (date-time) | The date and time when this entity was created. |
creatorId
required |
string (uuid) | The ID of the user who created this entity. nullable |
lastModificationTime
required |
string (date-time) | The date and time when this entity was last modified. nullable |
lastModifierId
required |
string (uuid) | The ID of the user who last modified this entity. nullable |
isDeleted
required |
boolean | Indicates whether this entity has been deleted. |
deleterId
required |
string (uuid) | The ID of the user who deleted this entity, if it is deleted. nullable |
deletionTime
required |
string (date-time) | The date and time when this entity was deleted, if it is deleted. nullable |
merchantId
required |
string (uuid) | Gets or sets the unique identifier of the merchant associated with the batch file. |
merchantName
required |
string | Gets or sets the merchant name associated with the batch file. nullable |
fileName
required |
string | Gets or sets the name of the file. nullable |
filePath
required |
string | Gets or sets the file system path to the batch file. nullable |
status
required |
all of BatchStatus | Gets or sets the current processing status of the batch file. |
totalTransactions
required |
integer (int32) | Gets or sets the total number of transactions included in the batch file. |
processedTransactions
required |
integer (int32) | Gets or sets the number of transactions that have been processed for the batch file. |
successfulTransactions
required |
integer (int32) | Gets or sets the number of transactions in the batch that completed successfully. |
failedTransactions
required |
integer (int32) | Gets or sets the number of transactions in the batch that failed to process. |
uploadedDate
required |
string (date-time) | Gets or sets the date and time when the batch file was uploaded. |
validatedDate
required |
string (date-time) | Gets or sets the date and time when the batch file was validated. nullable |
processingStartDate
required |
string (date-time) | Gets or sets the date and time when processing of the batch file started. nullable |
processingEndDate
required |
string (date-time) | Gets or sets the date and time when processing of the batch file completed. nullable |
processedByUserId
required |
string (uuid) | Gets or sets the unique identifier of the user who processed the batch file. nullable |
processedByUserName
required |
string | Gets or sets the name of the user who processed the batch file. nullable |
transactions
required |
array of BatchFileTransactionDto | Gets or sets the collection of transactions included in the batch file. nullable |
notes
required |
string | Gets or sets optional notes associated with the batch file. nullable |
errorMessage
required |
string | Gets or sets a human-readable description of the error associated with the batch file, if any. nullable |
concurrencyStamp
required |
string | Gets or sets a value used to detect concurrent updates to the batch file. nullable |
progressPercentage
required |
number (double) | Calculated property for progress percentage read only |
successRate
required |
number (double) | Calculated property for success rate read only |
This response has no documented body fields.
400 The batch file is not in a valid state for processing.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
404 No batch file exists with the specified ID.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
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.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded. Wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling.
Body: RateLimitProblemDetails
Each item has these fields.
| Field | Type | Description |
|---|---|---|
type
required |
string | The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable |
title
required |
string | A short, human-readable summary of the problem type. nullable |
status
required |
integer (int32) | The HTTP status code, repeated in the body as the problem-details format defines. |
detail
required |
string | A human-readable explanation of this occurrence of the problem. nullable |
retryAfterSeconds
required |
integer (int32) | How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. |
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.