---
title: "Cancel a bulk deposit (preview)"
method: POST
path: "/v0/sandbox/bulk-deposits/{paymentEntryId}/cancel"
tags: ["Sandbox"]
---

# Cancel a bulk deposit (preview)

`POST /v0/sandbox/bulk-deposits/{paymentEntryId}/cancel`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/sandbox/bulk-deposits/{paymentEntryId}/cancel`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/sandbox/bulk-deposits/:paymentEntryId/cancel/post.ts> (a function with typed inputs; its response is checked against the schema)

Cancels a bulk deposit as a whole, with every deposit order it created, as long as no wire has funded it. A funded bulk deposit cannot be canceled, and its deposit orders cannot be canceled one by one. A wire quoting a canceled bulk deposit is returned to its sender. Preview available in the sandbox environment only; its contract may still change.

## Path parameters

- `paymentEntryId` string, uuid, required: a Universally Unique Identifier

## Response `204`

Bulk deposit canceled

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `404`: NotFound
- `409`: Conflict
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/dd06889f4c79?raw)