Baixar comprovante de saque

Caso de uso

Use este endpoint para disponibilizar o comprovante digital de um saque Pix concluido. O PDF mostra a TurbofyPay como emissora da movimentacao, o beneficiario do saque, valor liquido, tarifa, data, identificadores de rastreabilidade e QR de validacao.

Endpoint

GET /v1/receipts/withdrawals/{id}

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 do saque.

Identificador aceito

O {id} pode ser qualquer identificador do saque Pix persistido pela Turbofy para o merchant autenticado:

id do saque Turbofy
providerTransferId
transferaTxId
providerEndToEndId
providerWithdrawalId
externalRef
endToEndId

Use o mesmo valor no path assinado. Exemplo: se baixar por providerWithdrawalId, assine /v1/receipts/withdrawals/{providerWithdrawalId}.

Assinatura HMAC

Assine a requisicao usando:

{timestamp}.GET./v1/receipts/withdrawals/{id}.

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-saque-{id}.pdf"
Cache-Control: private, no-store
corpo binario do PDF

Erros comuns

HTTP	code	Quando ocorre
`400`	`VALIDATION_ERROR`	Identificador invalido.
`401`	`INVALID_CREDENTIALS`	Credenciais ausentes ou invalidas.
`401`	`INVALID_SIGNATURE`	Assinatura ausente, invalida ou expirada.
`404`	`NOT_FOUND`	Saque inexistente para o merchant autenticado.
`409`	`RECEIPT_UNAVAILABLE`	Saque ainda nao esta concluido.

Exemplo de codigo

curl --request GET \
  --url https://api.turbofypay.com/v1/receipts/withdrawals/wd_2e97e17c_f636_4580_b29c_059f39319200 \
  --header "x-client-id: <client-id>" \
  --header "x-client-secret: <client-secret>" \
  --header "x-turbofy-timestamp: 1772805000000" \
  --header "x-turbofy-signature: <hmac-sha256>" \
  --output comprovante-saque.pdf

Regras de negocio

A consulta retorna somente saques 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 saques antigos, se o identificador estiver apenas no registro de saque Pix vinculado, a API resolve esse vinculo antes de gerar o PDF.
Para validar assinatura HMAC, revise Autenticacao.

Cobranca PIX

Payouts

Saques

Comprovantes

Baixar comprovante de saque

Caso de uso

Endpoint

Autenticacao

Identificador aceito

Assinatura HMAC

Response de sucesso

Erros comuns

Exemplo de codigo

Regras de negocio

​Caso de uso

​Endpoint

​Autenticacao

​Identificador aceito

​Assinatura HMAC

​Response de sucesso

​Erros comuns

​Exemplo de codigo

​Regras de negocio

Caso de uso

Endpoint

Autenticacao

Identificador aceito

Assinatura HMAC

Response de sucesso

Erros comuns

Exemplo de codigo

Regras de negocio