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.

​
Liquidação

Quando você cria um checkout, a cobrança e a liquidação acontecem em BRL. O comprador paga em reais por Pix, e o objeto settlement mostra a moeda, o status e o valor da liquidação.

​
O que isso significa na prática

Para o comprador

O valor sempre aparece em BRL e o pagamento acontece por Pix.

Para o seu sistema

Você acompanha o estado da cobrança pelo checkout. A liquidação aparece dentro do mesmo objeto, em settlement.

Para a contabilidade

Você lê settlement.currency, settlement.status e settlement.amount em BRL — sem precisar somar moedas diferentes.

Para o saque

Quando você decidir tirar dinheiro da conta, solicite o saque pelo app ou por POST /v1/withdrawals, usando o destino aprovado na conta. USDT só aparece nessa hora — não no checkout.

​
Como interpretar isso na API

Hoje, na API pública:
  • amount representa BRL em centavos
  • currency é sempre BRL
  • pix descreve o pagamento do comprador
  • settlement.currency é sempre BRL
  • settlement.status mostra o andamento da liquidação
  • settlement.amount é o valor liquidado em BRL como string decimal

​
Exemplo

{
  "id": "chk_4a8b3c1d5e6f2a9b0c1d",
  "amount": 12990,
  "currency": "BRL",
  "status": "PAID",
  "settlement": {
    "currency": "BRL",
    "status": "AVAILABLE",
    "amount": "129.90"
  }
}

​
Estados da liquidação

EstadoO que significa
PENDINGA liquidação ainda está em andamento
AVAILABLEO valor liquidado está disponível e foi creditado no seu saldo
COMPLETEDA liquidação foi finalizada
settlement.amount começa como null enquanto o checkout está PENDING. O valor aparece como string decimal (ex: "129.90") quando settlement.status avança para AVAILABLE ou COMPLETED.

​
O que o seu sistema deve assumir

  • o comprador sempre vê e paga o valor em BRL
  • a conciliação da cobrança continua sendo feita pelo checkout (id, externalId)
  • a leitura de liquidação acontece no objeto settlement
  • settlement.amount é decimal em string — não converta para Number em JavaScript se você precisa de precisão (use BigInt ou bibliotecas decimais)
Para acompanhar o saldo agregado da sua conta (todos os checkouts somados), use GET /v1/balance. Para mover dinheiro da conta para uma chave Pix ou carteira USDT, veja /flows/saques.

​
Próximos passos

Checkouts Pix

Veja onde o objeto settlement se encaixa no checkout completo.

Saldo

Leia o saldo agregado da sua conta pela API.

Saques

Entenda como solicitar saques em produção.

​
Precisa de ajuda para seguir?

Voltar ao Quickstart

Refaça o fluxo completo se você ainda estiver validando a primeira integração.

Revisar erros

Use essa página se algum valor ou status não aparecer como esperado.

Abrir o app

Revise chaves, ambiente e configuração da sua conta direto no app.