# POST /api/transactions/batch-file/{id}/cancel

Cancels a batch file that is pending or in progress.

Cannot cancel a batch file that has already completed or failed.
Sets the batch status to `Cancelled`.

**Operation ID:** `POST_api_transactions_batch-file_id_cancel`

## Authorization

No permission required.

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The batch file ID to cancel. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

Batch file cancelled successfully.

**Content type:** `text/plain`

Schema: `PhoeniXGateTransactionsBatchBackgroundBatchFileDto`

**Content type:** `application/json`

Schema: `PhoeniXGateTransactionsBatchBackgroundBatchFileDto`

**Content type:** `text/json`

Schema: `PhoeniXGateTransactionsBatchBackgroundBatchFileDto`

### 400

The batch file is already completed or failed and cannot be cancelled.

### 404

No batch file exists with the specified ID.

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 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.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.