> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codaclean.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Disable a bank account

> Disables the bank account on the customer.

It no longer appears in the customer's `bankAccounts`.

**Required scope:** `customers:delete`




## OpenAPI

````yaml DELETE /customers/{customerId}/bank-accounts/{iban}
openapi: 3.1.0
info:
  title: Codaclean API
  version: '1.0'
  description: >
    The Codaclean external API lets partner software (accounting tools, practice
    management software, sync agents) integrate with Codaclean on behalf of an
    accounting firm: manage its customers, request CODA and CODB mandates, and
    retrieve the CODA and CODB files Codaclean receives for them.
servers:
  - url: https://api.codaclean.io/v1
    description: Production
  - url: https://api.test.codaclean.io/v1
    description: Staging
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Authentication
    description: Obtain and refresh the ID token sent with every other call.
  - name: Utilities
    description: Connectivity check.
  - name: Customers
    description: The customers (client companies) managed by the accounting firm.
  - name: Bank accounts
    description: Bank accounts (IBANs) linked to a customer.
  - name: Customer payroll providers
    description: Payroll providers (social secretariats) linked to a customer.
  - name: Mandates
    description: CODA mandates (per bank account) and CODB mandates (per payroll provider).
  - name: Reference data
    description: Banks and payroll providers known to Codaclean.
  - name: CODA files
    description: Bank statement files in CODA format.
  - name: CODB files
    description: Payroll files in CODB format, delivered by payroll providers.
paths:
  /customers/{customerId}/bank-accounts/{iban}:
    parameters:
      - $ref: '#/components/parameters/CustomerId'
      - $ref: '#/components/parameters/Iban'
    delete:
      tags:
        - Bank accounts
      summary: Disable a bank account
      description: |
        Disables the bank account on the customer.

        It no longer appears in the customer's `bankAccounts`.

        **Required scope:** `customers:delete`
      operationId: disableCustomerBankAccount
      responses:
        '200':
          description: Done.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              examples:
                disabled:
                  summary: Bank account disabled
                  value:
                    message: >-
                      IBAN BE08068722124813 archived on customer
                      6ab7bba70d0379c741b7f74c
        '400':
          description: >-
            Invalid request (`invalidPayload`, `unknownField`,
            `invalidIdentifier`…).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidIdentifier:
                  summary: Malformed identifier
                  value:
                    message: Invalid customer identifier
                    code: invalidIdentifier
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: '`forbiddenScope` or `accessDenied`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                noApiKey:
                  summary: No API key
                  value:
                    message: Forbidden
                invalidApiKey:
                  summary: Invalid API key
                  value:
                    message: Forbidden
        '404':
          description: >-
            `customerNotFound`, or `ibanNotFound` — the IBAN is not linked to
            this customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ibanNotFound:
                  summary: IBAN not linked
                  value:
                    message: >-
                      IBAN BE08068722124813 is not linked to customer
                      6ab7bba70d0379c741b7f74c
                    code: ibanNotFound
        '409':
          description: '`customerAlreadyArchived` — the customer has been archived.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                customerAlreadyArchived:
                  summary: Archived customer
                  value:
                    message: Customer 6ab7bba70d0379c741b7f74c is already archived
                    code: customerAlreadyArchived
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    CustomerId:
      name: customerId
      in: path
      required: true
      description: >-
        Customer identifier (24-character hexadecimal string), as returned in
        `id`.
      schema:
        type: string
    Iban:
      name: iban
      in: path
      required: true
      description: >-
        IBAN of the bank account. Spaces are removed and letters are uppercased
        before use.
      schema:
        type: string
  schemas:
    Message:
      type: object
      description: Confirmation returned by actions that do not return a resource.
      required:
        - message
      properties:
        message:
          type: string
    Error:
      type: object
      description: >
        Error body. `code` is a stable, machine-readable token; it is present on
        errors returned by the customers, mandates and reference-data endpoints.
        Some errors carry extra keys, such as `fields` or `candidates`.
      required:
        - message
      properties:
        message:
          type: string
          description: Human-readable description. Do not parse it.
        code:
          type: string
          description: |
            Machine-readable error code.

            **See also:** [Errors](/api/errors#error-codes)
        fields:
          type: array
          items:
            type: string
          description: >-
            Offending fields. Present with `unknownField` and
            `fieldNotUpdatable`.
        candidates:
          type: array
          description: Present with `connectorSelectionRequired`.
          items:
            $ref: '#/components/schemas/ConnectorCandidate'
    ConnectorCandidate:
      type: object
      properties:
        connectorId:
          type: integer
        name:
          type: string
        bicCode:
          type: string
        available:
          type: boolean
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired ID token, or user not allowed to use the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            noToken:
              summary: No ID token
              value:
                message: Unauthorized
            invalidToken:
              summary: Invalid or expired ID token
              value:
                message: Unauthorized
    TooManyRequests:
      description: Rate limit or quota exceeded for this API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            tooManyRequests:
              summary: Rate limit exceeded
              value:
                message: Too Many Requests
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                message: Internal server error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Identifies the partner software. Issued by Codaclean. Required on every
        call, including `POST /token`.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT (Cognito ID token)
      description: >-
        Identifies the user and their accounting firm. Send the `idToken`
        returned by `POST /token` as `Authorization: Bearer <idToken>`. Valid
        for 1 hour.

````