Skip to main content
GET /balance devolve quanto você tem na conta agora, separado em disponível e reservado. Exige a permissão balance:read.

A resposta

Os valores são reais decimais: 1250.5 é R$ 1.250,50. Uma conta nova responde com os dois campos em 0.

Disponível e reservado

O saldo fica reservado em duas situações:
  • Transferência em andamento. Quando você solicita uma transferência, o valor sai do disponível e fica reservado até a operação terminar. Se ela der approved, o valor é debitado de vez. Se der failed, ele volta para o disponível.
  • Reserva da conta. Dependendo da configuração da sua conta, uma parte das vendas aprovadas fica retida por um prazo antes de virar disponível.
Reservado não é perdido. É seu e será liberado ou debitado quando a operação que o originou terminar.

Confira o saldo antes de transferir

Uma transferência acima do disponível é recusada com 422 (operation_refused, “Saldo insuficiente”). Evite a falha conferindo antes, lembrando que a tarifa também sai do saldo quando coverFee é true (o padrão das transferências).
JavaScript
O saldo muda a cada Pix recebido e a cada transferência. A conferência acima reduz falhas, mas não elimina a corrida entre duas operações simultâneas. Sempre trate o 422 de saldo insuficiente.

Transferir por Pix

Envie saldo por chave, Copia e Cola ou QR Code.

Consultar saldo

Referência completa do endpoint.