Skip to main content
GET
cURL
Este endpoint obtém o saldo total e detalhes de todas as contas bancárias conectadas à conta do usuário.

Descrição

O endpoint GET /tools/api/get-balance retorna o saldo total consolidado de todas as contas bancárias do usuário autenticado.

Autenticação

Este endpoint requer autenticação via Bearer token e assinatura ativa.
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

Parâmetros de Query

Response

Response Fields

Objeto Account

Respostas de Erro

Exemplos de Uso

cURL

JavaScript

Python

Observações

  • Apenas contas bancárias são incluídas no cálculo do saldo
  • Contas de cartão de crédito são excluídas deste endpoint
  • O saldo total é a soma de todos os saldos individuais das contas
  • Os saldos das contas são em tempo real e refletem o estado atual das contas conectadas

Authorizations

Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Response

Dados de saldo consolidado

success
boolean
Example:

true

data
any
timestamp
string<date-time>