SAQ DigitalDocs

    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.

    GEThttps://api.saq.digital/v2/finance/receipt-transaction/file
    curl --request GET \
  --url 'https://api.saq.digital/v2/finance/receipt-transaction/file' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>'

    Endpoint

    GET /v2/finance/receipt-transaction/file

    Headers

    ParameterTypeDescriptionExample
    AuthorizationStringBearer + Access_tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

    Query Parameters

    ParameterTypeDescriptionRequiredExample
    idIntegerTransaction ID. Either id or uuid must be provided (not both).conditional12345
    uuidStringTransaction UUID. Either id or uuid must be provided (not both).conditionalabc123-def
    languageStringLanguage for the receipt. See TranslationsEnum values below. Default: portuguese.optionalenglish
    typeStringReceipt type. See TypeTransaction enum values below. Default: TRANSACTION.optionalTRANSACTION

    Enum: TranslationsEnum

    ValueDescription
    englishReceipt in English language
    portugueseReceipt in Portuguese language (default)
    chineseReceipt in Chinese language

    Enum: TypeTransaction

    ValueDescription
    TRANSACTIONRegular transaction receipt (cashin, cashout, PIX) - Default
    REFUNDRefund transaction receipt

    Request Examples

    Get transaction receipt by ID (Portuguese):

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

    Get transaction receipt by UUID (English):

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

    Get refund receipt:

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

    Get receipt in Chinese:

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

    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 CodeError MessageDescription
    400Does not have id or uuidNeither id nor uuid parameter was provided. You must provide one of them.
    400Transaction not foundThe transaction with the specified ID or UUID does not exist.
    403ForbiddenYou don't have permission to access this transaction. Either it belongs to a different company or you don't have the required permissions.
    401UnauthorizedInvalid or missing authentication token. Ensure you are sending a valid Bearer token.
    404Transaction not foundThe transaction does not exist or has been deleted.
    422Validation errorOne 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