> For the complete documentation index, see [llms.txt](https://docs.delos.financial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delos.financial/batchservice/cancel-batch.md).

# Cancel Batch

Closes a batch permanently. The batch moves from `OPEN` or `CHANGE_REQUESTED` to `CANCELLED` and no longer counts against the limit of 3 open batches.

Cancellation is one-way: a cancelled batch never reopens. Calling it again on a `CANCELLED` batch is a no-op. A `CLOSED`batch cannot be cancelled (`409`); reopen it with Request Batch Changes first.

What happens to rows:

* Rows that were never submitted to compliance review become `failed`.
* Rows already submitted cannot be withdrawn and still receive a final result.

**Endpoint**

`POST /v2/compliance/batch/{batch_id}/cancel`

**Link**

<https://partner.sandbox.delos.financial/openapi/v2.html#/operations/BatchService_CancelBatch>

**Request**

**Path Parameters**

| Parameter      | Type     | Description                        | Required | Example                                  |
| -------------- | -------- | ---------------------------------- | -------- | ---------------------------------------- |
| **`batch_id`** | `string` | Batch ID returned by Create Batch. | Yes      | `"01a0af8b-831f-7dbe-8eaf-459f81998958"` |

**Headers**

| Key             | Value              | Required |
| --------------- | ------------------ | -------- |
| `Authorization` | `<JWT>`            | Yes      |
| `Accept`        | `application/json` | Yes      |

**Body**

No request body.

**Response (200 OK)**

Returns the `Batch` object. See Create Batch → Response Fields for every field and the `counters` object.

**Example Response:**

```json
{
  "batch_id": "01a0af8b-831f-7dbe-8eaf-459f81998958",
  "status": "CANCELLED",
  "schema_version": "string",
  "types": [
    "individual",
    "company"
  ],
  "individual_kyc_level": "string",
  "company_kyc_level": "string",
  "party_kyc_levels": [
    "string"
  ],
  "counters": {
    "total": 120,
    "draft": 0,
    "valid": 0,
    "invalid": 3,
    "creating": 2,
    "submitted": 85,
    "finished": 24,
    "change_requested": 4,
    "rejected": 1,
    "failed": 1
  },
  "processed": false,
  "done": false,
  "created_at": "2026-09-28T10:15:30Z",
  "committed_at": "2026-09-28T11:02:04Z",
  "error": ""
}
```

***

**Examples**

**Request**

```bash
curl --request POST \
  --url <https://partner.sandbox.delos.financial/v2/compliance/batch/01a0af8b-831f-7dbe-8eaf-459f81998958/cancel> \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <JWT>'
```

***

**Error Responses**

Errors are returned as `{"code", "message", "details"}`, where `code` is a gRPC status code. Use the HTTP status for error handling.

**Batch Cannot Be Cancelled (409)** — the batch is `CLOSED`:

```json
{ "code": 10, "message": "batch cannot be cancelled from its current state", "details": [] }
```

**Batch Not Found (404)** — the batch does not exist or belongs to another partner:

```json
{ "code": 5, "message": "batch not found", "details": [] }
```

**Authorization fail (401)**:

```json
{ "code": 16, "message": "Unauthorized", "details": [] }
```

***

**Notes**

* **Irreversible**: to onboard the same customers later, create a new batch.
* **Submitted rows keep going**: customers already under review are not affected. Track their results with List Batch Items.
* **Freeing a slot**: cancel draft batches you no longer need so that Create Batch does not return `409`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.delos.financial/batchservice/cancel-batch.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.