> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get cashout receipt

> Generates a receipt for a cashout operation.
Returns JSON with cashout details, account information, and a base64-encoded PDF.
Only available for cashouts with status COMPLETED, PARTIALLY_RETURNED, or RETURNED.
Requires the cashout to have an end-to-end ID.




## OpenAPI

````yaml /api-spec.yaml get /v1/banking/cashouts/{id}/receipt
openapi: 3.1.0
info:
  title: Rinne API
  version: 1.0.0
  description: >
    **Rinne API** is a robust payment platform that offers integration with
    multiple payment providers.


    ## Authentication


    The API uses API Key authentication via the `x-api-key` header. Each company
    has a unique key to access resources.


    ## Response Format


    All responses follow a consistent format:

    - **Success**: Returns the requested data directly

    - **Error**: Returns an `error` object with detailed information


    ## Pagination


    Endpoints that return lists support pagination through parameters:

    - `page`: Page number (default: 1)

    - `limit`: Items per page (default: 20, maximum: 100)


    ## Supported Providers


    The API supports multiple payment providers:

    - **Rinne**: Internal provider

    - **Celcoin**: PIX integration and other financial services


    ## Raw Card Data (PCI Endpoints)


    Card credential fields (`card_data.number`, `card_data.cvv`,
    `card_data.network_token`,

    `card_data.cryptogram`, and the 3DS `card.number`) must always be sent
    encrypted —

    values start with the `ev:` prefix. Plaintext values are rejected with

    `400 VALIDATION_ERROR` on every host.


    There are two ways to send encrypted values:

    - **rinne-js**: card forms and wallet buttons (Apple Pay / Google Pay)
    encrypt
      credentials client-side before they leave the browser.
    - **PCI API host**: server-to-server integrations that handle raw card data
    must call
      `https://pci.api.rinne.com.br/core` (sandbox: `https://pci.api-sandbox.rinne.com.br/core`)
      instead of the regular host. This endpoint encrypts `number` and `cvv` in transit
      before the request reaches the API; all other fields pass through unchanged.

    The PCI host serves only transaction creation and 3DS session creation (both
    the

    self and merchant variants); use the regular host for everything else.
  contact:
    name: Rinne API Support
    email: suporte@rinne.com.br
servers:
  - url: https://api-sandbox.rinne.com.br/core
    description: Sandbox
  - url: https://api.rinne.com.br/core
    description: Production
security: []
tags:
  - name: System
    description: System and API health endpoints
  - name: Authentication
    description: User authentication and authorization endpoints
  - name: Management
    description: >-
      Merchant management endpoints - create, list, get specific, overview,
      update
  - name: Transactions
    description: Transaction operations for merchants - create, list, overview, refunds
  - name: Affiliations
    description: Affiliation management for merchants
  - name: Banking
    description: Banking operations for merchants - balance, cashout, statements
  - name: Bank Accounts
    description: Bank account management for merchants
  - name: Pix Keys
    description: PIX key management for merchants
  - name: Company Transactions
    description: Direct transaction management and query endpoints for companies
  - name: Companies
    description: Company management
  - name: Company Affiliations
    description: Payment provider affiliation management
  - name: Company Banking
    description: Company banking endpoints (balance, etc.)
  - name: Company Pix
    description: Company PIX key management
  - name: Company Ledger
    description: Company ledger entry query endpoints
  - name: Ledger
    description: Ledger entry query endpoints (company and merchants)
  - name: Cards
    description: Stored card management (self and merchant)
  - name: Webhooks
    description: Endpoints for receiving webhooks from external providers
  - name: Pricing
    description: Fee and cost policy management for transaction pricing
  - name: Users
    description: User management endpoints
  - name: Roles
    description: Role management endpoints
  - name: Permissions
    description: Permission management endpoints
paths:
  /v1/banking/cashouts/{id}/receipt:
    get:
      tags:
        - Company Banking
      summary: Get cashout receipt
      description: >
        Generates a receipt for a cashout operation.

        Returns JSON with cashout details, account information, and a
        base64-encoded PDF.

        Only available for cashouts with status COMPLETED, PARTIALLY_RETURNED,
        or RETURNED.

        Requires the cashout to have an end-to-end ID.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: The cashout ID
      responses:
        '200':
          description: Receipt generated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashOutReceiptResponse'
        '400':
          description: |
            Receipt not available. Possible reasons:
            - Cashout status is PENDING, PROCESSING, or FAILED
            - Cashout does not have an end-to-end ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationErrorResponse'
        '404':
          description: Cashout not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CashOutReceiptResponse:
      type: object
      description: Cashout receipt response with PDF
      required:
        - cashout
        - payer
        - receiver
        - pdf_file_base64
      properties:
        cashout:
          $ref: '#/components/schemas/CashOutReceiptCashout'
        payer:
          $ref: '#/components/schemas/ReceiptBankAccount'
          description: Origin account (payer) information
        receiver:
          $ref: '#/components/schemas/ReceiptAccount'
          description: Destination account (receiver) information
        pdf_file_base64:
          type: string
          description: Base64-encoded PDF receipt
          example: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo...
    ValidationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation error
            status:
              type: integer
              example: 400
            details:
              type: object
              properties:
                issues:
                  type: array
                  items:
                    type: object
                    properties:
                      field:
                        type: string
                        example: email
                      type:
                        type: string
                        example: REQUIRED
                      message:
                        type: string
                        example: Field 'email' is required
                      value:
                        anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                        example: invalid_value
                      constraints:
                        type: object
                        example:
                          min: 18
                          max: 120
            path:
              type: string
              example: /companies
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    AuthenticationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: AUTHENTICATION_ERROR
            message:
              type: string
              example: Authentication required to access this resource
            status:
              type: integer
              example: 401
            details:
              type: object
              properties:
                reason:
                  type: string
                  example: Invalid API key
            path:
              type: string
              example: /companies/me
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    NotFoundErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: RESOURCE_NOT_FOUND
            message:
              type: string
              example: Company with ID '123' not found
            status:
              type: integer
              example: 404
            path:
              type: string
              example: /companies/me
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    InternalServerErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: INTERNAL_SERVER_ERROR
            message:
              type: string
              example: An unexpected error occurred
            status:
              type: integer
              example: 500
            path:
              type: string
              example: /companies
            timestamp:
              type: string
              format: date-time
              example: '2023-12-01T10:00:00.000Z'
            requestId:
              type: string
              example: req_123456789
    CashOutReceiptCashout:
      type: object
      description: Cashout details for receipt
      required:
        - id
        - amount
        - fee
        - net_amount
        - currency
        - status
        - method
        - end_to_end_id
        - created_at
      properties:
        id:
          type: string
          format: uuid
          description: Cashout ID
          example: 123e4567-e89b-12d3-a456-426614174000
        amount:
          type: integer
          description: Cashout amount + fee in cents
          example: 5034
        fee:
          type: integer
          description: Fee charged in cents
          example: 10
        net_amount:
          type: integer
          description: Cashout amount in cents
          example: 5024
        currency:
          type: string
          enum:
            - BRL
          description: Currency code
          example: BRL
        status:
          type: string
          enum:
            - COMPLETED
            - PARTIALLY_RETURNED
            - RETURNED
          description: Cashout status (only eligible statuses)
          example: COMPLETED
        method:
          type: string
          enum:
            - PIX
          description: Cashout method
          example: PIX
        end_to_end_id:
          type: string
          description: PIX end-to-end ID
          example: E13935893202601271529YV9B1m6o2Ih
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2026-01-27T12:29:21.000Z'
    ReceiptBankAccount:
      type: object
      description: Bank account information for receipts
      required:
        - name
        - document
        - bank_name
        - ispb
        - branch
        - account
      properties:
        name:
          type: string
          description: Account holder name
          example: WALTER NOBRE DA SILVA CONCEICAO
        document:
          type: string
          description: Account holder document (CPF may be masked, CNPJ shown in full)
          example: XXX.588.782-XX
        bank_name:
          type: string
          description: Bank name
          example: BCO SANTANDER (BRASIL) S.A.
        ispb:
          type: string
          description: Bank ISPB code
          example: '90400888'
        branch:
          type: string
          description: Branch number
          example: '2305'
        account:
          type: string
          description: Account number
          example: '010227424'
    ReceiptAccount:
      type: object
      description: >-
        Account information for receipts. At least one of bank_account or
        pix_data must be provided.
      properties:
        bank_account:
          $ref: '#/components/schemas/ReceiptBankAccount'
        pix_data:
          $ref: '#/components/schemas/ReceiptPixData'
    ReceiptPixData:
      type: object
      description: PIX key information for receipts
      required:
        - key
        - type
      properties:
        key:
          type: string
          description: PIX key value
          example: '12345678901'
        type:
          type: string
          enum:
            - CPF
            - CNPJ
            - EMAIL
            - PHONE
            - EVP
          description: PIX key type
          example: CPF
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Company API key for authentication

````