TransaçõesComprovante de Transação Bancária

Comprovante de Transação Bancária

Gera o comprovante em PDF de uma transação bancária (Pix, TED, transferência entre contas Conta Simples ou pagamento de boleto) e retorna uma URL assinada de curta duração para download.

Regras:

  • Só há comprovante para transações com status PROCESSADO (status: 2).
  • Verifique o campo showReceipt da transação (no extrato bancário) antes de chamar — ele indica se a operação gerou comprovante.
  • A URL de download é assinada e expira em 5 minutos (veja expiresAt); faça uma nova requisição caso ela expire.
  • Tipos de transação sem comprovante suportado retornam 404.
curl -X GET "https://api-sandbox.contasimples.com/statements/v1/banking/106615/receipt" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "downloadUrl": "https://banking-transaction-receipts.s3.amazonaws.com/company-id/106615.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=300&X-Amz-Signature=...",
  "expiresAt": "2026-07-16T18:52:50.000Z"
}
GET
/statements/v1/banking/{transactionId}/receipt
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
path
transactionIdinteger
Required

ID da transação bancária, obtido no array transactions da resposta do extrato bancário.

header
Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header
Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

transactionIdinteger
Required

ID da transação bancária, obtido no array transactions da resposta do extrato bancário.

Example:
106615

Headers

Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Responses

downloadUrlstring
Required

URL assinada de curta duração para baixar o PDF do comprovante.

expiresAtstring
Required

Data e hora (ISO 8601) em que a URL de download expira (padrão: 5 minutos após a geração).