Skip to main content
List Bank Accounts
curl --request GET \
  --url https://api.chargefy.io/v1/bank-accounts
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": false,
  "url": "/v1/bank-accounts"
}
Retorna uma página de bank_account no envelope de lista canônico. A listagem é escopada pela organização atuante: API key de organização lista contas da própria organização; API key de plataforma lista contas da organização conectada indicada no header Organization. Contas desconectadas da organização atuante não aparecem na lista. Para exibir apenas a conta ativa atual no admin da plataforma, prefira GET /v1/organizations/{id} e leia organization.bank_account. Use a listagem quando precisar mostrar histórico de contas conectadas ou quando ainda não tiver o ba_* de uma conta específica.

​
Autenticação

CredencialAcesso
JWT de usuárioRequer acesso à organização.
API key da organizaçãoApenas a própria organização da key.
API key da plataformaOrganização conectada indicada no header Organization.

​
Parâmetros de query

​
limit
integer
default:"10"
Itens por página. Máximo 100.
​
starting_after
string
Cursor para buscar a próxima página depois do ID informado.
​
ending_before
string
Cursor para buscar a página anterior antes do ID informado.
​
is_active
boolean
Filtra contas ativas ou inativas.
​
is_verified
boolean
Filtra contas verificadas ou não verificadas.
​
type
string
Filtra por checking ou savings.
​
created[gte]
string
Filtra contas criadas a partir deste timestamp.
​
created[gt]
string
Filtra contas criadas depois deste timestamp.
​
created[lte]
string
Filtra contas criadas até este timestamp.
​
created[lt]
string
Filtra contas criadas antes deste timestamp.
cURL
curl -X GET "https://api.chargefy.io/v1/bank-accounts?limit=10&is_active=true" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Organization: org_789"

​
Resposta

​
object
string
Sempre "list".
​
data
array
Lista de objetos bank_account.
​
has_more
boolean
true quando existe próxima página.
​
url
string
Caminho canônico da coleção: /v1/bank-accounts.
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": false,
  "url": "/v1/bank-accounts"
}

​
Erros

StatusQuando
401Credencial ausente, inválida, revogada ou expirada.
403Credencial sem acesso à organização.
409Contas bancárias ainda não são suportadas no sandbox.
500Erro temporário listando contas bancárias. Faça retry.