Skip to main content

Visão Geral

O endpoint de consulta de saldo permite que você obtenha informações detalhadas sobre o saldo da conta autenticada em tempo real. A resposta inclui três tipos de saldo:
  • Saldo Bruto (Gross Balance): Valor total disponível na conta
  • Saldo Bloqueado (Blocked Balance): Valores reservados para operações pendentes
  • Saldo Líquido (Net Balance): Valor disponível para uso imediato
Este endpoint requer um token Bearer válido. Verifique a documentação de autenticação para mais detalhes.

Endpoint

GET /api/balance

Retorna o saldo atual da conta autenticada.

Headers Obrigatórios

Request

Response (200 OK)

Estrutura da Resposta

number
obrigatório
Saldo bruto total da conta (saldo líquido + saldo bloqueado)Exemplo: 48734.90
number
obrigatório
Valor bloqueado por operações pendentes (pagamentos em processamento, cobranças aguardando confirmação)Exemplo: 0.00
number
obrigatório
Saldo líquido disponível para uso imediato (grossBalance - blockedBalance)Exemplo: 48734.90
string
obrigatório
Data e hora da consulta no formato ISO 8601 (UTC)Exemplo: 2025-11-19T20:18:29.384Z

Exemplos de Implementação

Node.js / TypeScript

Python

PHP

Casos de Uso

1. Dashboard de Gestão Financeira

Exiba o saldo em tempo real em um dashboard administrativo:

2. Validação Antes de Pagamento

Verifique se há saldo suficiente antes de realizar um pagamento:

3. Relatório de Conciliação

Gere relatórios de conciliação com saldo atual:

Entendendo Saldo Bloqueado

O saldo bloqueado representa valores temporariamente indisponíveis devido a:
Quando você envia um pagamento PIX (seja por chave PIX ou via QR Code), o valor é imediatamente bloqueado até a confirmação da transação.Exemplo:
  • Saldo inicial: R$ 1.000,00
  • Pagamento de R$ 250,00 iniciado
  • Saldo líquido: R$ 750,00
  • Saldo bloqueado: R$ 250,00
Cobranças PIX geradas mas ainda não pagas pelos clientes não afetam o saldo bloqueado. O bloqueio ocorre apenas após o pagamento, durante o processamento.
Solicitações de estorno podem bloquear temporariamente o valor até a conclusão da análise.

Códigos de Resposta

Consulte a Referência da API para detalhes completos dos campos de resposta.

Considerações

O saldo retornado reflete o estado no momento exato da consulta. Para operações críticas, sempre consulte o saldo imediatamente antes da transação.
  • Cache: Não recomendamos cache de saldo por mais de 1 minuto
  • Precisão: Valores são retornados com 2 casas decimais
  • Moeda: Todos os valores são em Reais (BRL)

Monitoramento e Alertas

Implementando Alertas de Saldo

Próximos Passos

Realizar Pagamento PIX

Envie pagamentos para qualquer chave PIX

Gerar Cobrança PIX

Crie cobranças para receber pagamentos