Skip to main content
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. 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.
{
  "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"
}
id
string
Identificador público da conta bancária. Usa o prefixo ba_*.
object
string
Sempre "bank_account".
account_number_last4
string
Últimos 4 dígitos da conta. O número completo nunca é retornado.
bank_code
string
Código do banco.
bank_name
string | null
Nome do banco. Vem null quando indisponível.
created_at
string | null
Data de criação em ISO 8601.
holder_name
string
Nome do titular da conta.
is_active
boolean
true quando esta conta bancária está ativa no cadastro financeiro.
is_verified
boolean
Indica se a conta já foi verificada.
livemode
boolean
true em produção; false em ambiente de teste.
metadata
object
Reservado para metadata pública do objeto. Atualmente retorna {}.
routing_number
string
Agência ou identificador de roteamento.
type
string
Tipo da conta: checking ou savings.
updated_at
string | null
Data da última atualização em ISO 8601.

Operações

Relações

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