Caso de uso
Use este endpoint para disponibilizar ao seu ERP, checkout ou atendimento o comprovante digital oficial de uma transacao paga.
O arquivo retornado e um PDF com identidade TurbofyPay, dados de pagador, dados de recebedor, valor, data, identificadores de rastreabilidade e QR de validacao.
Endpoint
Alias aceito para integracoes que usam o termo cobranca:
Autenticacao
Headers obrigatorios:
x-client-id
x-client-secret
x-turbofy-timestamp
x-turbofy-signature
A chave de API precisa estar ativa e pertencer ao merchant dono da transacao.
Identificador aceito
O {id} pode ser qualquer identificador da cobranca/transacao persistido pela Turbofy para o merchant autenticado:
id da cobranca Turbofy
externalRef
providerChargeId
pixTxid
endToEndId
providerTransactionId
Use o mesmo valor no path assinado. Exemplo: se baixar por endToEndId, assine /v1/receipts/transactions/{endToEndId}.
Assinatura HMAC
Assine a requisicao usando:
Em requisicoes GET, o corpo assinado e vazio. Gere uma assinatura nova para cada download.
Response de sucesso
Em 200, a API retorna:
Content-Type: application/pdf
Content-Disposition: inline; filename="comprovante-transacao-{id}.pdf"
Cache-Control: private, no-store
- corpo binario do PDF
Erros comuns
Exemplo de codigo
Regras de negocio
- A consulta retorna somente comprovantes do merchant autenticado.
- O PDF nao deve ser armazenado em cache publico.
- O comprovante e gerado pela TurbofyPay com dados financeiros e rastreabilidade Pix disponiveis no momento da emissao.
- Para transacoes antigas, se o
endToEndId estiver apenas no registro de transacao Pix vinculado, a API resolve esse vinculo antes de gerar o PDF.
- Para validar assinatura HMAC, revise Autenticacao.
Last modified on June 8, 2026