---
title: "Deactivate an Account Number"
method: POST
path: "/v1/account_number/{account_number_id}/deactivate"
tags: ["Account Number"]
---

# Deactivate an Account Number

`POST /v1/account_number/{account_number_id}/deactivate`

## Request

- Base URL: `https://api.sandbox.lead.bank`
- URL: `https://api.sandbox.lead.bank/v1/account_number/{account_number_id}/deactivate`
- Auth: HTTP bearer

Deactivate an Account Number.

## Path parameters

- `account_number_id` string, required

## Request body

- object
  - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object.

## Response `200`

Successful response

- AccountNumber
  - `id` string: The ID of the retrieved Account Number.
  - `account_number` string: The account number.
  - `routing_number` string: The routing number.
  - `account_id` string: The ID of the Account object.
  - `client_customer_id` string: The ID of your customer.
  - `entity_id` string: The ID of your entity.
  - `status` 'active' | 'inactive' | 'canceled' | 'unassigned': Account Number Status
  - `ach_controls` AchControls: ACH payment controls
    - `originator_id` string: The ID of the Originator object.
    - `incoming` IncomingAch: Incoming ACH payment controls
      - `accept_credit` boolean: Accept ACH credits
      - `accept_debit` boolean: Accept ACH debits
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_company_ids_allowlist` CompanyId[]: Allowed Company IDs when mode is allowlist_only
    - `outgoing` OutgoingAch: Outgoing ACH payment controls
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_numbers_allowlist` AllowedCounterpartyAccount[]: Allowed destinations when mode is allowlist_only
        - `type` 'us_domestic', required
        - `account_number` string, required
        - `routing_number` string, required
  - `wire_controls` WireControls: Wire payment controls
    - `incoming` IncomingWire: Incoming Wire payment controls
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_numbers_allowlist` AllowedCounterpartyAccount[]: Allowed destinations when mode is allowlist_only
        - `type` 'us_domestic', required
        - `account_number` string, required
        - `routing_number` string, required
    - `outgoing` OutgoingWire: Outgoing Wire payment controls
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_numbers_allowlist` AllowedCounterpartyAccount[]: Allowed destinations when mode is allowlist_only
        - `type` 'us_domestic', required
        - `account_number` string, required
        - `routing_number` string, required
    - `outgoing_international` OutgoingInternationalWire: Outgoing International Wire payment controls
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_international_account_numbers_allowlist` AllowedInternationalCounterpartyAccount[]: Allowed international destinations when mode is allowlist_only
        - `business_identifier_code` string, required: BIC (Business Identifier Code / SWIFT code)
        - `account_identifier` object, required: Account identifier for the international account
          - `type` 'IBAN' | 'account_number', required: Type of account identifier
          - `value` string, required: The account identifier value
  - `internal_transfer_controls` InternalTransferControls: Internal Transfer controls
    - `incoming` IncomingInternalTransfer: Controls for receiving internal transfers
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_number_ids_allowlist` AccountNumberID[]: Allowlist of account_number IDs that can send
    - `outgoing` OutgoingInternalTransfer: Controls for sending internal transfers
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_number_ids_allowlist` AccountNumberID[]: Allowlist of account_number IDs to send to
  - `instant_payment_controls` InstantPaymentControls: Instant Payment controls
    - `incoming` IncomingInstantPayment: Incoming Instant Payment controls
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_numbers_allowlist` AllowedUsDomesticCounterpartyAccount[]: Allowed destinations when mode is allowlist_only
        - `account_number` string, required
        - `routing_number` string, required
    - `outgoing` OutgoingInstantPayment: Outgoing Instant Payment controls
      - `counterparty_filter` 'accept_all' | 'reject_all' | 'allowlist_only': Control mode for counterparty filtering
      - `counterparty_account_numbers_allowlist` AllowedUsDomesticCounterpartyAccount[]: Allowed destinations when mode is allowlist_only
        - `account_number` string, required
        - `routing_number` string, required
  - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object.
  - `created_at` string, date-time: The timestamp of creation in ISO-8601 format.
  - `updated_at` string, date-time: The timestamp of last update in ISO-8601 format.

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/lead/apis/lead-bank.md) - [All operations](https://skmtc.dev/lead/apis/lead-bank/llms.txt) - [OpenAPI document](https://skmtc.dev/lead/apis/lead-bank/revisions/2c659854496e?raw)