---
title: "Archive a bank account"
method: POST
path: "/v3/funding-accounts/banks/{bankAccountId}/archive"
tags: ["funding-accounts"]
---

# Archive a bank account

`POST /v3/funding-accounts/banks/{bankAccountId}/archive`

Archive an existing bank account. In the response, the `archived` field is set as `true`.

Archiving a bank account at BILL has a set of requirements.
* **Bank account status**: The bank account `status` must be set as `VERIFIED`. You can verify the bank account with `POST /v3/funding-accounts/banks/{bankAccountId}/verify`.
* **Bank account user status**: The bank account user `verificationStatus` must be set as `VERIFIED`. To begin the verification process, nominate a bank account user with `POST /v3/funding-accounts/banks/users`.

## Path parameters

- `bankAccountId` string, required — BILL-generated ID of the bank account. The value begins with `bac`.

## Headers

- `sessionId` string, nullable — API session ID generated with `/v3/login`
- `devKey` string, nullable — Developer key generated with your BILL developer account

## Response `200`

Archive a bank account response

- OrganizationBankAccountResponseDto — Bank account response.
  - `id` string, required — BILL-generated ID of the bank account. The value begins with `bac`.
  - `archived` boolean, required — Set as `true` if the bank account is archived
  - `status` 'NOT_VERIFIED' | 'VERIFIED' | 'PENDING' | 'BLOCKED' | 'EXPIRED' | 'INVALID' | 'UNDEFINED' — Bank account status.
  - `createdBy` string — BILL-generated ID of the user that created the bank account. The value begins with `006`.
  - `routingNumber` string — Bank routing number
  - `accountNumber` string — Bank account number
  - `nameOnAccount` string — Full name on bank account
  - `type` 'CHECKING' | 'SAVINGS' — Bank account type
  - `ownerType` 'BUSINESS' | 'PERSONAL' — Bank account owner type
  - `bankName` string — Bank name
  - `accessToAdmins` boolean — Set as `true` to enable access to all users with the `ADMINISTRATOR` user role
  - `default` object — Bank account default values for BILL AP and AR operations
    - `payables` boolean — Set as `true` if the bank account is set as default for Accounts Payable operations
    - `receivables` boolean — Set as `true` if the bank account is set as default for Accounts Receivable operations
  - `createdTime` string, date-time — Created date and time
  - `updatedTime` string, date-time — Updated date and time
  - `chartOfAccountId` string — BILL-generated ID of the chart of accounts for the bank account. The value begins with `0ca`.

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

[API](https://skmtc.net/bill/apis/bill-v3-api.md) · [All operations](https://skmtc.net/bill/apis/bill-v3-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bill/bill-v3-api/revisions/0483350c434e/schema)