Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.troqpay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Saldo

GET /v1/balance te devolve o saldo agregado da sua conta — quanto entrou, quanto foi cobrado em taxas, quanto está disponível para saque e quanto está retido. Tudo em BRL, como string decimal.

​
Quando usar

Para mostrar saldo no seu painel

Se o seu produto tem uma área meu saldo, leia direto da API em vez de manter um espelho local.

Antes de fazer um saque

Confira availableAmount antes de pedir um saque pelo app ou pela API para garantir que o valor está disponível.

​
Como funciona

1

Faça uma chamada autenticada

GET https://api.troqpay.com/v1/balance com Authorization: Bearer trq_test_... ou trq_live_....
2

Leia os campos

A resposta traz oito valores, todos em BRL como string decimal.
3

Use availableAmount como referência de saque

availableAmount é o que está realmente liberado para você sacar agora.

​
Exemplo

curl https://api.troqpay.com/v1/balance \
  -H "Authorization: Bearer trq_test_8b3c1d5e6f2a9b0c1d4a8b3c"

{
  "livemode": false,
  "currency": "BRL",
  "grossAmount": "5430.00",
  "feeAmount": "54.30",
  "pendingAmount": "129.90",
  "availableAmount": "5375.70",
  "reservedAmount": "0.00",
  "blockedAmount": "0.00"
}

​
Como ler cada campo

CampoO que significa
livemodetrue para chaves trq_live_, false para trq_test_
currencySempre BRL
grossAmountTotal bruto recebido (antes das taxas)
feeAmountTotal de taxas cobradas pela troqpay
pendingAmountValores ainda em liquidação
availableAmountDisponível para saque agora
reservedAmountReservado para saques já solicitados
blockedAmountRetido (por exemplo, valores em disputa ou bloqueio operacional)
Os valores são strings decimais, não números. Em JavaScript, evite Number(balance.availableAmount) — você pode perder precisão. Use uma biblioteca decimal (bignumber.js, decimal.js) ou BigInt em centavos.

​
O que esperar em cenários diferentes

CenárioComportamento
Conta em produção sem APPROVED403 forbidden
Sem checkouts aindaTodos os campos em "0.00"
Saque solicitado, ainda não pagoO valor sai de availableAmount e entra em reservedAmount
Saque concluídoO valor sai de reservedAmount e some do saldo

​
Próximos passos

Solicitar saque

Solicite saques (Pix ou carteira USDT) com o destino aprovado na conta.

Boas práticas

Veja o que vale a pena salvar em logs ao operar saldo e checkouts.

API Reference

Consulte o schema completo de GET /v1/balance na referência.

​
Precisa de ajuda para seguir?

Revisar autenticação

Confira chaves, ambiente e o gate de produção antes de chamar saldo em LIVE.

Revisar erros

Veja o que 403 forbidden ou 401 unauthorized querem dizer.

Abrir o app

Confira o saldo no app para comparar com o que a API devolve.