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

# Archive a customer bank account

`POST /v3/customers/{customerId}/bank-accounts/{bankAccountId}/archive`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/customers/{customerId}/bank-accounts/{bankAccountId}/archive`
- Auth: none declared

Archive an existing customer bank account. In the response, the `archived` field is set as `true`. An archived customer bank account cannot be restored.

## Path parameters

- `customerId` string, required: BILL-generated ID of the customer. The value begins with `0cu`.
- `bankAccountId` string, required: BILL-generated ID of the customer bank account. The value begins with `cba`.

## 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 customer bank account response

- CustomerBankAccountResponseDto: CustomerBankAccount response Dto.
  - `id` string: BILL-generated ID of the customer bank account. The value begins with `cba`.
  - `nameOnAccount` string: Customer bank account name
  - `nickname` string: Customer bank account nickname
  - `routingNumber` string: Customer bank routing number
  - `accountNumber` string: Customer bank account number
  - `type` 'CHECKING' | 'SAVINGS': Customer bank account type.
  - `ownerType` 'BUSINESS' | 'PERSONAL': Customer bank account owner type.
  - `status` 'NOT_VERIFIED' | 'VERIFIED' | 'PENDING' | 'BLOCKED' | 'EXPIRED' | 'INVALID' | 'UNDEFINED': Customer bank account status.
  - `archived` boolean: Set as `true` if the customer bank account is archived
  - `createdTime` string, date-time: Created date and time
  - `updatedTime` string, date-time: Updated date and time

## Other responses

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

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)