Skip to main content
Retorna a conta bancária ativa da organização. Implementa estratégia “sync on load”: primeiro busca no banco de dados local; se não encontrada, consulta o gateway diretamente e sincroniza o resultado no banco para consultas futuras.

Autenticação

Não requer autenticação específica (endpoint público com validação interna).

Parâmetros de Path

id
string
required
ID da organização

Resposta

id
string
ID interno da conta bancária (presente quando encontrada no banco de dados)
bank_code
string
Código do banco (ex: 341 para Itaú)
bank_name
string
Nome do banco
routing_number
string
Número da agência
account_number_last4
string
Últimos 4 dígitos da conta
account_type
string
Tipo da conta: checking (corrente) ou savings (poupança)
is_verified
boolean
Se a conta bancária foi verificada
synced_from_zoop
boolean
Se os dados foram sincronizados diretamente do gateway nesta requisição (nome do campo conforme contrato da API)
sync_failed
boolean
Presente com valor true se a sincronização com o banco de dados falhou (mas os dados do gateway são retornados)

Erros

CódigoDescrição
404Nenhuma conta bancária encontrada (nem no banco de dados nem no gateway)

Exemplo

curl -X GET "https://api.chargefy.io/api/v1/organizations/org_abc123/bank-account"

Resposta de Exemplo (encontrada no banco de dados)

{
  "id": "sba_abc123",
  "bank_code": "341",
  "bank_name": "Itaú Unibanco",
  "routing_number": "1234",
  "account_number_last4": "5678",
  "account_type": "checking",
  "is_verified": true,
  "synced_from_zoop": false
}

Resposta de Exemplo (sincronizada do gateway)

{
  "id": "sba_xyz789",
  "bank_code": "033",
  "bank_name": "Santander",
  "routing_number": "0001",
  "account_number_last4": "9012",
  "account_type": "checking",
  "is_verified": false,
  "synced_from_zoop": true
}