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.

​
Introdução

A troqpay ajuda você a vender no Brasil com Pix e acompanhar a cobrança pelo seu backend. Nesta documentação, você vai aprender a:
  • criar um checkout Pix
  • acompanhar o status da cobrança
  • receber eventos por webhook
  • ler o saldo da sua conta
  • solicitar saques em produção (Pix ou carteira USDT)
  • operar com chaves de teste e produção

​
Quando faz sentido integrar a troqpay

Use a troqpay quando você precisa:
  • gerar cobranças Pix a partir do seu próprio backend
  • conciliar pagamentos com externalId
  • reagir ao pagamento em tempo real
  • cobrar em BRL pela API e acompanhar saldo no mesmo lugar

Em uma frase

Seu cliente paga em BRL por Pix, seu sistema acompanha o checkout — e quando quiser sacar, usa o destino aprovado na conta e solicita pelo app ou pela API.

​
Tudo gira em torno do checkout

É no checkout que você encontra:
  • o valor cobrado em BRL
  • os dados do Pix para pagamento
  • o status da cobrança
  • os metadados do seu pedido
  • o objeto settlement com a liquidação em BRL

​
O que vale a pena salvar no seu sistema

Identificadores

Salve checkout.id e externalId. Eles resolvem boa parte da sua conciliação e do suporte.

Contexto do pedido

Guarde também amount, currency, description e os campos de metadata que façam sentido para o seu fluxo.

Separação de ambiente

Use livemode para nunca misturar eventos e registros de teste com produção.

Liquidação

Leia settlement.currency, settlement.status e settlement.amount para acompanhar o estado da liquidação em BRL.

​
Fluxo recomendado

1

Criar o checkout

Seu backend envia POST /v1/checkouts com valor, descrição e dados do pedido.
2

Exibir o Pix para o comprador

A API responde com copyPaste, qrCodeUrl e checkoutUrl, para você escolher o melhor formato de exibição.
3

Acompanhar o pagamento

O caminho recomendado é processar webhooks. Consulta serve para conferência, reconciliação e suporte.
4

Atualizar seu sistema

Quando o pagamento é confirmado, o checkout muda de status e o objeto settlement passa a refletir o estado da liquidação em BRL.

​
Saldo e saques

A troqpay também expõe a leitura do saldo agregado da sua conta:
  • GET /v1/balance retorna o saldo separado em valores brutos, taxas, pendentes, disponíveis, reservados e bloqueados — todos como string decimal em BRL.
Saques (Pix ou carteira USDT) podem ser solicitados em produção pelo app ou por POST /v1/withdrawals. A criação pela API exige conta aprovada, destino de saque aprovado, saldo disponível, Idempotency-Key e chave com permissão de saque. Veja /flows/saldo para o detalhe do endpoint de saldo e /flows/saques para o fluxo de saque.

​
Como navegar nesta documentação

Se você quer integrar rápido

Comece pelo Quickstart. Ele te leva do zero até o primeiro checkout.paid.

Se você quer entender o modelo

Siga por Checkouts Pix, Webhooks e API Reference para aprofundar o comportamento da API.

​
Próximos passos

Fazer o Quickstart

Valide a primeira cobrança do início ao fim.

Entender autenticação

Veja chaves, ambiente e idempotência.

Modelar os checkouts Pix

Entenda o ciclo de vida da cobrança e o que salvar no seu sistema.

​
Precisa de ajuda para seguir?

Teste no sandbox

Use o ambiente de teste para validar checkout, webhook e reconciliação sem tráfego real.

Revise os erros

Entenda o que fazer quando uma chamada falha ou um payload não passa.

Abra o app

Gere chaves, reveja sua conta e mantenha teste e produção bem separados.