Glossário

Use esta página quando você quiser confirmar rapidamente o significado de um termo da documentação.

Prefixos de ID

Prefixo	Recurso	Forma
`chk_`	Checkout	20 caracteres hex
`evt_`	Evento de webhook	24 caracteres hex
`req_`	Identificador de requisição	24 caracteres hex
`plink_`	Link de pagamento	16 caracteres hex

Termo	O que significa
`Checkout`	Objeto principal da API para criar, exibir e acompanhar uma cobrança Pix
`externalId`	Identificador do pedido ou registro do seu sistema
`Idempotency-Key`	Header usado para evitar criações duplicadas quando a mesma requisição precisa ser reenviada
`livemode`	Campo que indica se o evento ou checkout veio de teste (`false`) ou produção (`true`)
`settlement`	Objeto que concentra os dados relacionados à liquidação
`requestId`	Identificador de uma chamada HTTP, útil para logs e investigação
`event.id`	Identificador único de um evento de webhook
`copyPaste`	String do Pix copia e cola
`qrCodeUrl`	URL da imagem do QR Code do Pix
`checkoutUrl`	URL de um checkout hospedado pela troqpay
`paymentLinkId`	Identificador do link de pagamento criado no app — formato `plink_<16 hex>`
`Saldo`	Leitura do saldo da conta via `GET /v1/balance` (valores em decimal)
Estado de aprovação da conta	Indica em que etapa sua conta está para cobrar com `trq_live_`: `NOT_REQUESTED`, `PENDING_REVIEW`, `APPROVED` ou `REJECTED`. Veja Autenticação para detalhes.

Termo	O que significa
`trq_test_`	Prefixo de chave para ambiente de teste
`trq_live_`	Prefixo de chave para ambiente de produção
`sandbox`	Ambiente para validar integração sem cobranças reais
`produção`	Ambiente usado para cobranças reais

Termo	O que significa
`PENDING`	Checkout criado e aguardando pagamento
`PAID`	Pagamento Pix confirmado
`EXPIRED`	Checkout expirado sem pagamento
`CANCELLED`	Checkout cancelado
`settlement.PENDING`	Liquidação ainda em andamento
`settlement.AVAILABLE`	Liquidação disponível, com valor em BRL
`settlement.COMPLETED`	Liquidação concluída

Volte ao caminho mais curto para validar a integração.

Veja onde cada termo aparece dentro do objeto principal da API.

Entenda como requestId, code e message aparecem nas falhas.