Receipt Transaction File

GET https://api.somossimpay.com.br/v2/finance/receipt-transaction/file

This API generates and downloads a transaction receipt in PDF format. It supports both regular transactions and refunds, with multi-language support. The PDF includes all transaction details formatted for printing or digital sharing.

Endpoint

GET /v2/finance/receipt-transaction/file

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo
hmac	String	HMAC (Hash-based Message Authentication Code) is an authentication algorithm that combines a private key with a message to create a Message Authentication Code (MAC).	hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6

Query Parameters

Parameter	Type	Description	Required	Example
id	Integer	Transaction ID. Either id or uuid must be provided (not both).	conditional	12345
uuid	String	Transaction UUID. Either id or uuid must be provided (not both).	conditional	abc123-def
language	String	Language for the receipt. See TranslationsEnum values below. Default: portuguese.	optional	english
type	String	Receipt type. See TypeTransaction enum values below. Default: TRANSACTION.	optional	TRANSACTION

Enum: TranslationsEnum

Value	Description
english	Receipt in English language
portuguese	Receipt in Portuguese language (default)
chinese	Receipt in Chinese language

Enum: TypeTransaction

Value	Description
TRANSACTION	Regular transaction receipt (cashin, cashout, PIX) - Default
REFUND	Refund transaction receipt

Request Examples

Get transaction receipt by ID (Portuguese):

HTTP

GET /v2/finance/receipt-transaction/file?id=12345
Authorization: Bearer <access_token>
hmac: <computed_hmac>

Get transaction receipt by UUID (English):

HTTP

GET /v2/finance/receipt-transaction/file?uuid=abc123-def-456&language=english
Authorization: Bearer <access_token>
hmac: <computed_hmac>

Get refund receipt:

HTTP

GET /v2/finance/receipt-transaction/file?id=12345&type=REFUND&language=portuguese
Authorization: Bearer <access_token>
hmac: <computed_hmac>

Get receipt in Chinese:

HTTP

GET /v2/finance/receipt-transaction/file?id=12345&language=chinese
Authorization: Bearer <access_token>
hmac: <computed_hmac>

Response Details

Content-Type: application/pdf

Response Headers:

Content-Type: application/pdf
Content-Disposition: attachment; filename="Empresa XYZ.pdf"

The response is a binary PDF file stream. The filename is derived from the source account name (or "comprovante" if name is not available).

PDF Content Includes:

• Transaction type
• Transaction status
• Amount transferred
• Date and time
• Source account details (name, document, bank)
• Destination account details (name, document, bank)
• Transaction ID (End-to-End ID)
• Transaction UUID
• Error details (if applicable)
• Additional notes or tags

Error Responses

HTTP Code	Error Message	Description
400	Does not have id or uuid	Neither id nor uuid parameter was provided. You must provide one of them.
400	Transaction not found	The transaction with the specified ID or UUID does not exist.
403	Forbidden	You don't have permission to access this transaction. Either it belongs to a different company or you don't have the required permissions.
401	Unauthorized	Invalid or missing authentication token. Ensure you are sending a valid Bearer token and HMAC signature.
404	Transaction not found	The transaction does not exist or has been deleted.
422	Validation error	One or more query parameters are invalid. Check parameter types and values.

Business Rules

Transaction Identification:

• You must provide either id OR uuid parameter (not both)
• id is the numeric transaction identifier
• uuid is the alphanumeric transaction code

Receipt Types:

• TRANSACTION: For cashout, cashin, PIX transfers, and other regular transactions (default)
• REFUND: For refund transactions with additional refund-specific information

Language Support:

• Supported languages: english, portuguese (default), chinese
• If an invalid or unsupported language is provided, defaults to Portuguese
• Language selection affects PDF labels, headers, and field names only
• Transaction data (amounts, dates, account names) is not translated

PDF Response:

• Returns a binary PDF file stream with Content-Type: application/pdf
• Filename is derived from the source account name (e.g., "Company Name.pdf")
• Falls back to "comprovante.pdf" if account name is not available
• PDF is formatted for A4 size, suitable for digital viewing and printing

Access Restrictions:

• You can only access receipts for transactions belonging to your account
• Authentication is required for all requests