Skip to main content
POST

Descrição

Retorna os saldos disponíveis, futuros e retidos dos estabelecimentos especificados.

Headers

string
required
Bearer token JWT obtido no login

Request Body

array
required
Array de IDs dos estabelecimentos para consultar saldos

Response

number
Saldo disponível para saque (em centavos)
number
Saldo futuro a receber (em centavos)
number
Saldo retido (em centavos)

Tipos de Saldo

Saldo Disponível

Valor que pode ser sacado imediatamente. Inclui transações já liquidadas e liberadas.

Saldo Futuro

Valor a receber de transações aprovadas mas ainda não liquidadas (aguardando prazo de liquidação).

Saldo Retido

Valor retido conforme configuração de retenção do estabelecimento (garantia, reserva técnica, etc).

Exemplo Completo

Próximos Passos

Listar Transações

Ver transações que compõem o saldo

Criar Pagamento

Processar novo pagamento