---
title: "Cancel a linked bank account"
method: PATCH
path: "/v1/linked_bank_accounts/{linked_bank_account_id}/cancel"
tags: ["LinkedBankAccounts"]
---

# Cancel a linked bank account

`PATCH /v1/linked_bank_accounts/{linked_bank_account_id}/cancel`

Cancels an existing linked bank account. This can be used to cancel a linked bank account before it has been reviewed. The linked bank account must be in 'created' status.

## Path parameters

- `linked_bank_account_id` string, uuid, required

## Headers

- `request-id` string
- `correlation-id` string
- `idempotency-key` string

## Response `200`

OK

- ItemResponseOfLinkedBankAccountV1
  - `meta` ResponseMetadata, required — Metadata about the API request, including an identifier and timestamp.
    - `api_request_id` string, uuid, required — Unique identifier for this API request, useful for troubleshooting.
    - `api_request_timestamp` string, date-time, required — Timestamp for this API request, useful for troubleshooting.
  - `response_type` 'object' | 'array' | 'error' | 'none', required — Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned.
  - `data` LinkedBankAccountV1, required
    - `id` string, uuid, required — Unique identifier for the linked bank account.
    - `account_id` string, uuid, nullable, required — The unique identifier of the Straddle account related to this bank account.
    - `status` 'created' | 'onboarding' | 'active' | 'rejected' | 'inactive' | 'canceled', required — The current status of the linked bank account.
    - `status_detail` StatusDetailOfLinkedBankAccountStatusDetailEnum, required
      - `reason` 'unverified' | 'in_review' | 'pending' | 'stuck' | 'verified' | 'failed_verification' | 'disabled' | 'new', required — A machine-readable identifier for the specific status, useful for programmatic handling.
      - `source` 'watchtower', required — Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.
      - `code` string, required — A machine-readable code for the specific status, useful for programmatic handling.
      - `message` string, required — A human-readable message describing the current status.
    - `bank_account` BankAccountV1, required
      - `institution_name` string, required
      - `account_holder` string, required
      - `routing_number` string, required
      - `account_mask` string, required
    - `metadata` object, nullable — Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the linked bank account in a structured format.
    - `created_at` string, date-time, required — Timestamp of when the bank account object was created.
    - `updated_at` string, date-time, required — Timestamp of the most recent update to the linked bank account.
    - `platform_id` string, uuid, nullable — The unique identifier of the Straddle Platform relatd to this bank account.
    - `purposes` string[], required — The purposes for the linked bank account.
    - `description` string, nullable — Optional description for the bank account.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Validation Failed
- `500` — Server Error

---

[API](https://skmtc.net/straddleio/apis/straddle-api.md) · [All operations](https://skmtc.net/straddleio/apis/straddle-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/straddleio/straddle-api/revisions/6e13cd88cda9/schema)
