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.

​
Links de pagamento

Um link de pagamento é uma URL pública e reutilizável que você cria no app para um produto da sua conta. Cada vez que alguém abre o link e paga, a troqpay cria um checkout novo e ele aparece na lista de cobranças com o mesmo contexto de produto. Hoje, links de pagamento são gerenciados só pelo app. Não existe API pública para criar, listar, atualizar ou deletar links.

​
Como funciona

1

Crie o produto e o link no app

Em app.troqpay.com, crie um produto e gere um link de pagamento associado a ele.
2

Compartilhe a URL

A URL pública tem o formato https://pay.troqpay.com/l/{paymentLinkId}.
3

Cada uso vira um checkout

Quando um comprador abre o link e paga, a troqpay cria um novo checkout — exatamente igual aos checkouts criados via POST /v1/checkouts.
4

Reconcilie pelo seu sistema

O checkout criado a partir do link aparece na sua lista de cobranças e dispara os webhooks normalmente (checkout.created, checkout.paid, checkout.expired).

​
Identificadores

paymentLinkId

Identificador do link no formato plink_<16 hex>. Exibido no app e usado na URL pública.

checkoutId

Identificador da cobrança individual gerada quando alguém paga. Formato chk_<20 hex>. É esse ID que você usa para consultar e reconciliar.

Ativo

O link aceita pagamentos e cria checkouts a cada uso.

Inativo

O link continua acessível na URL, mas a página renderiza um estado não-pagável. Nenhum checkout é criado.
Você ativa e desativa o link diretamente no app.

​
O que existe na API pública

A API pública não expõe endpoints de gerenciamento de links de pagamento. Não tente listar, criar ou atualizar links via REST. O que existe na API pública:
  • consulta de checkouts criados a partir de links — eles aparecem em GET /v1/checkouts/{checkoutId} como qualquer outro checkout
  • webhooks de ciclo de vida de checkout (checkout.created, checkout.paid, checkout.expired) — entregues normalmente
Checkouts criados a partir de um link de pagamento carregam metadados internos que ligam o checkout ao link. Esses metadados são usados pela troqpay para o produto/painel; você não precisa lê-los para reconciliar — checkout.id e externalId (quando configurado no link) já bastam.
CenárioCaminho recomendado
Você tem um produto fixo e quer compartilhar uma URL única (newsletter, link na bio)Crie um link no app
Você precisa de cobrança dinâmica com valor, descrição ou metadata por compraPOST /v1/checkouts direto
Você quer cobrar em massa via campanha de marketingLink, mais simples de operacionalizar
Você precisa de cobrança por API integrada ao seu fluxoPOST /v1/checkouts

​
Próximos passos

Checkouts Pix

Veja a forma do checkout, que é a mesma para criação direta e via link.

Webhooks

Aprofunde como ouvir os eventos de pagamento — eles funcionam igual para link.

Abrir o app

Crie produtos e links de pagamento direto no app.

​
Precisa de ajuda para seguir?

Quickstart

Se você ainda não fez a primeira cobrança via API, comece pelo Quickstart.

Glossário

Veja o que paymentLinkId, checkoutId e os outros termos significam.

API Reference

Consulte os endpoints públicos do checkout que se aplicam aqui também.