Banks

Remove a bank connection

delete/v1/banks/{bid}

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/banks/{bid}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

bidstring required

Bank ID

Query parameters

permanent'true' | 'false'

When "true", removes the bank permanently: the connection is revoked at the provider, everything derived from it is destroyed, and the bank is deleted immediately rather than at the next monthly cleanup. Irreversible, and requires the admin or owner role in a signed-in session: an API key or an OAuth token is refused with 403 SIGNED_IN_SESSION_REQUIRED. Defaults to a reversible soft delete.

Response

Bank removed

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.