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

# Overview

> O objeto Bank Account

Uma `bank_account` representa uma conta bancária cadastrada para recebimentos
no cadastro financeiro. Organizações conectadas podem enxergar essa conta por
vínculo: quando a organização atuante tem uma conta bancária conectada, ela
aparece em `organization.bank_account`; antes disso, o campo vem `null`.

A Chargefy nunca retorna o número completo da conta. Para identificação e
conciliação visual, o objeto expõe apenas banco, agência, titular e os quatro
últimos dígitos da conta.

Para exibir a conta atual de uma organização conectada no admin da plataforma,
prefira ler [`organization.bank_account`](/api-reference/organizations/object).
Use os endpoints de `bank_accounts` quando precisar listar contas conectadas,
consultar um `ba_*` específico ou trocar/desconectar a conta ativa.

## Data Object

Este é o formato completo retornado em `organization.bank_account`, nos
endpoints de `bank_accounts` e em `data.object.bank_account` dos webhooks que
carregam uma `organization`.

```json theme={}
{
  "id": "ba_123",
  "object": "bank_account",
  "account_number_last4": "5678",
  "bank_code": "001",
  "bank_name": "Banco Exemplo S.A.",
  "created_at": "2026-05-16T14:09:27Z",
  "holder_name": "Acme Ltda",
  "is_active": true,
  "is_verified": false,
  "livemode": true,
  "metadata": {},
  "routing_number": "0001",
  "type": "checking",
  "updated_at": "2026-05-16T14:20:00Z"
}
```

<ResponseField name="id" type="string">
  Identificador público da conta bancária. Usa o prefixo `ba_*`.
</ResponseField>

<ResponseField name="object" type="string">
  Sempre `"bank_account"`.
</ResponseField>

<ResponseField name="account_number_last4" type="string">
  Últimos 4 dígitos da conta. O número completo nunca é retornado.
</ResponseField>

<ResponseField name="bank_code" type="string">
  Código do banco.
</ResponseField>

<ResponseField name="bank_name" type="string | null">
  Nome do banco. Vem `null` quando indisponível.
</ResponseField>

<ResponseField name="created_at" type="string | null">
  Data de criação em ISO 8601.
</ResponseField>

<ResponseField name="holder_name" type="string">
  Nome do titular da conta.
</ResponseField>

<ResponseField name="is_active" type="boolean">
  `true` quando esta conta bancária está ativa no cadastro financeiro.
</ResponseField>

<ResponseField name="is_verified" type="boolean">
  Indica se a conta já foi verificada.
</ResponseField>

<ResponseField name="livemode" type="boolean">
  `true` em produção; `false` em ambiente de teste.
</ResponseField>

<ResponseField name="metadata" type="object">
  Reservado para metadata pública do objeto. Atualmente retorna `{}`.
</ResponseField>

<ResponseField name="routing_number" type="string">
  Agência ou identificador de roteamento.
</ResponseField>

<ResponseField name="type" type="string">
  Tipo da conta: `checking` ou `savings`.
</ResponseField>

<ResponseField name="updated_at" type="string | null">
  Data da última atualização em ISO 8601.
</ResponseField>

## Operações

* [Criar bank account](/api-reference/bank-accounts/create)
* [Listar bank accounts](/api-reference/bank-accounts/list)
* [Consultar bank account](/api-reference/bank-accounts/get)
* [Desconectar bank account](/api-reference/bank-accounts/delete)

## Relações

O objeto `bank_account` também é retornado como campo aninhado em:

* [`organization.bank_account`](/api-reference/organizations/object)
* [`organization.updated.data.object.bank_account`](/api-reference/webhooks/organization.updated)