Delete Bank Rule

DELETE /banking/bank-rules/{id}

Group: Banking › Bank Rules · Operation ID: deleteBankRule

Delete a bank rule and its criteria, bank account mappings and action object, addressed by the :id path segment. A hard delete; entries the rule already created are untouched. Prefer PATCH with status 'inactive' to retire a rule. Returns an empty response. Every request must carry the Api-Version header.

Deletes one bank rule, addressed by the id in the path. The response is empty.

This is a hard delete and it cascades. The rule's criteria, its bank account mappings and its action object go with it. Entries the rule already created, and the matches it already made, are untouched — they belong to the documents, not to the rule.

Prefer deactivating. PATCH banking/bank-rules/{id} with {"status": "inactive"} stops the rule running while keeping it readable and re-activatable. Delete when the rule was a mistake, not when it has served its purpose.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	Id of the bank rule to delete (a UUID); bound from the :id path segment.

Response

200 Success

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error