> ## 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.

# List cashouts

> Returns a paginated list of cashouts for the authenticated company.
Supports filtering by status, method, and date range.
Requires the banking.list permission.




## OpenAPI

````yaml /api-spec.yaml get /v1/banking/cashouts
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:
    get:
      tags:
        - Company Banking
      summary: List cashouts
      description: |
        Returns a paginated list of cashouts for the authenticated company.
        Supports filtering by status, method, and date range.
        Requires the banking.list permission.
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          description: Page number
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          required: false
          description: Number of items per page
        - in: query
          name: status
          schema:
            type: array
            items:
              type: string
              enum:
                - PENDING
                - PROCESSING
                - COMPLETED
                - FAILED
                - PARTIALLY_RETURNED
                - RETURNED
          required: false
          description: Filter by cashout status (array)
          style: form
          explode: false
        - in: query
          name: method
          schema:
            type: array
            items:
              type: string
              enum:
                - PIX
          required: false
          description: Filter by cashout method (array)
          style: form
          explode: false
        - in: query
          name: request_id
          schema:
            type: string
          required: false
          description: Filter by request ID
          example: b941fcaf-d77e-448c-9bdd-e7effd269fb7
        - in: query
          name: origin_bank_account_id
          schema:
            type: string
          description: Filter by origin bank account ID
          example: 123e4567-e89b-12d3-a456-426614174000
        - in: query
          name: destination_bank_account_id
          schema:
            type: string
          description: Filter by destination bank account ID
          example: 123e4567-e89b-12d3-a456-426614174001
        - in: query
          name: created_at_from
          schema:
            type: string
            format: date-time
          required: false
          description: Filter cashouts from this date
        - in: query
          name: created_at_to
          schema:
            type: string
            format: date-time
          required: false
          description: Filter cashouts to this date
        - in: query
          name: sort
          schema:
            type: string
          required: false
          description: Sort by field(s) (e.g., "created_at", "-amount", "status")
          example: '-created_at,amount'
      responses:
        '200':
          description: Cashouts retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashOutListResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationErrorResponse'
        '403':
          description: Insufficient permissions to access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CashOutListResponse:
      type: object
      description: Paginated cashout list response
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          description: List of cashouts
          items:
            $ref: '#/components/schemas/CashOutResponse'
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
    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
    AuthorizationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: AUTHORIZATION_ERROR
            message:
              type: string
              example: You need 'admin' permissions to access this resource
            status:
              type: integer
              example: 403
            path:
              type: string
              example: /companies
            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
    CashOutResponse:
      type: object
      description: Cashout response
      required:
        - id
        - request_id
        - external_request_id
        - company_id
        - origin_bank_account_id
        - amount
        - currency
        - method
        - status
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Internal cashout ID
          example: 123e4567-e89b-12d3-a456-426614174000
        request_id:
          type: string
          description: Client-generated request ID
          example: req_123456789
        external_request_id:
          type: string
          format: uuid
          description: External provider request ID
          example: 123e4567-e89b-12d3-a456-426614174000
        company_id:
          type: string
          format: uuid
          description: Company ID
          example: 123e4567-e89b-12d3-a456-426614174000
        origin_bank_account_id:
          type: string
          format: uuid
          description: ID of the bank account to debit from
          example: 123e4567-e89b-12d3-a456-426614174000
        destination_bank_account_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            ID of the bank account to credit to (null when destination is a PIX
            key)
          example: 123e4567-e89b-12d3-a456-426614174001
        destination_pix_key_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            ID of the company PIX key paid to (null when destination is a bank
            account)
          example: 223e4567-e89b-12d3-a456-426614174002
        amount:
          type: integer
          description: Amount to transfer in cents
          example: 10000
        currency:
          type: string
          enum:
            - BRL
          description: Currency code
          example: BRL
        fee:
          type: integer
          description: Total fee in cents charged on the cashout
          example: 150
        cost:
          type: integer
          description: Total cost in cents for this cashout
          example: 100
        fee_policy_id:
          type:
            - string
            - 'null'
          format: uuid
          description: ID of the fee policy used for pricing this cashout
          example: 123e4567-e89b-12d3-a456-426614174002
        cost_policy_id:
          type:
            - string
            - 'null'
          format: uuid
          description: ID of the cost policy used for pricing this cashout
          example: 123e4567-e89b-12d3-a456-426614174003
        method:
          type: string
          enum:
            - PIX
          description: Cashout method
          example: PIX
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - PARTIALLY_RETURNED
            - RETURNED
            - FAILED
          description: Cashout status
          example: PROCESSING
        error_message:
          type:
            - string
            - 'null'
          description: Error message if cashout failed
          example: Insufficient funds
        returned_amount:
          type:
            - integer
            - 'null'
          description: Total amount returned in cents (sum of all returns)
          example: 5000
        latest_return_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of the latest return
          example: '2025-01-01T11:00:00.000Z'
        returns:
          type: array
          description: List of returns
          items:
            $ref: '#/components/schemas/CashOutReturn'
        metadata:
          type:
            - object
            - 'null'
          nullable: true
          additionalProperties: true
          description: Metadata object for storing custom key-value pairs
          example:
            custom_field: value
            order_id: order_123
        end_to_end_id:
          type:
            - string
            - 'null'
          description: End to End ID from the payment provider (PIX transaction identifier)
          example: E12345678202501271234567890123456
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2025-01-01T10:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2025-01-01T10:05:00.000Z'
    PaginationResponse:
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
        - hasNext
        - hasPrev
      properties:
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 20
        total:
          type: integer
          example: 50
        totalPages:
          type: integer
          example: 3
        hasNext:
          type: boolean
          example: true
        hasPrev:
          type: boolean
          example: false
    CashOutReturn:
      type: object
      description: Cashout return record
      required:
        - id
        - cashout_id
        - provider_return_id
        - amount
        - reason
        - return_identification
        - original_end_to_end_id
        - original_id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Return record ID
          example: 123e4567-e89b-12d3-a456-426614174004
        cashout_id:
          type: string
          format: uuid
          description: ID of the cashout this return belongs to
          example: 123e4567-e89b-12d3-a456-426614174000
        provider_return_id:
          type: string
          description: Unique PIX return ID from provider
          example: b94150c9-7dad-4b21-8183-50c83f4c5dd8
        amount:
          type: integer
          description: Amount returned in cents
          example: 1000
        reason:
          type: string
          enum:
            - BANKING_ERROR
            - FRAUD
            - CUSTOMER_REQUEST
            - PIX_WITHDRAWAL_OR_CHANGE_ERROR
          description: |
            Reason for the return.
            - BANKING_ERROR: Banking system error
            - FRAUD: Fraudulent transaction
            - CUSTOMER_REQUEST: Customer requested return
            - PIX_WITHDRAWAL_OR_CHANGE_ERROR: PIX withdrawal or change error
          example: CUSTOMER_REQUEST
        return_identification:
          type: string
          description: Return identification from provider
          example: return_123456789
        original_end_to_end_id:
          type: string
          description: Original transaction end-to-end ID
          example: E12345678202501011100000000001
        original_id:
          type: string
          description: Original transaction ID
          example: tx_123456789
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2025-01-01T11:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2025-01-01T11:00:00.000Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Company API key for authentication

````