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

# Listar saques

> Histórico de saques (cashouts) do produtor, paginado. Escopo: `cashouts:read` (dado financeiro — escopo próprio, opt-in).



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/cashouts/history
openapi: 3.0.3
info:
  title: Ticto API v2
  version: 2.0.0
  description: >-
    API pública da Ticto para criar produtos e ofertas e ler pedidos,
    assinaturas e saques. Autenticação por token Bearer com escopos granulares.
    Todo acesso é isolado ao produtor dono do token — por construção, não por
    checagem por endpoint.
servers:
  - url: https://api.ticto.cloud
    description: Produção (tokens ticto_live_)
  - url: https://sandbox.ticto.cloud
    description: Sandbox (tokens ticto_test_)
security:
  - bearerAuth: []
tags:
  - name: Produtos
    description: Criação e leitura de produtos.
  - name: Ofertas
    description: Criação e leitura de ofertas de um produto.
  - name: Pedidos
    description: Leitura de pedidos (paridade com a API v1).
  - name: Assinaturas
    description: Leitura de assinaturas (paridade com a API v1).
  - name: Saques
    description: Leitura de saques/cashouts (paridade com a API v1).
paths:
  /api/v2/cashouts/history:
    get:
      tags:
        - Saques
      summary: Listar saques
      description: >-
        Histórico de saques (cashouts) do produtor, paginado. Escopo:
        `cashouts:read` (dado financeiro — escopo próprio, opt-in).
      operationId: listCashouts
      parameters:
        - name: status
          in: query
          schema:
            type: string
          description: Filtra por status.
        - name: created_after
          in: query
          schema:
            type: string
            format: date
        - name: created_before
          in: query
          schema:
            type: string
            format: date
        - name: per_page
          in: query
          schema:
            type: integer
            default: 15
            maximum: 100
      responses:
        '200':
          description: Histórico de saques.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashoutList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - bearerAuth:
            - cashouts:read
components:
  schemas:
    CashoutList:
      type: object
      description: >-
        Histórico de saques, paginado. Envelope do paginador: `data` + `links` +
        `meta`.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CashoutItem'
        links:
          $ref: '#/components/schemas/PaginatorLinks'
        meta:
          $ref: '#/components/schemas/PaginatorMeta'
    CashoutItem:
      type: object
      description: >-
        Um item do histórico de saques (`GET /cashouts/history`). Origem: Smaug
        (via Phoenix).
      properties:
        id:
          type: integer
        code:
          type: string
          nullable: true
          description: Código público do saque.
        status:
          type: string
          description: Situação do saque.
          example: paid
        amount:
          type: integer
          description: Valor solicitado em centavos.
        fee:
          type: integer
          description: Tarifa do saque em centavos.
        net_value:
          type: integer
          description: Valor líquido creditado em centavos.
        bank_account:
          type: object
          nullable: true
          properties:
            bank_name:
              type: string
            agency:
              type: string
            account:
              type: string
        created_at:
          type: string
          example: 01/06/2026 10:00:00
        updated_at:
          type: string
          example: 01/06/2026 18:20:00
      example:
        id: 7781
        code: CO25X9AB
        status: paid
        amount: 148800
        fee: 367
        net_value: 148433
        bank_account:
          bank_name: Nubank
          agency: '0001'
          account: 1234567-8
        created_at: 01/06/2026 10:00:00
        updated_at: 01/06/2026 18:20:00
    PaginatorLinks:
      type: object
      properties:
        first:
          type: string
          nullable: true
        last:
          type: string
          nullable: true
        prev:
          type: string
          nullable: true
        next:
          type: string
          nullable: true
    PaginatorMeta:
      type: object
      description: >-
        Metadados de paginação dos endpoints de leitura (paginador do Laravel,
        paridade com a v1).
      properties:
        current_page:
          type: integer
        from:
          type: integer
          nullable: true
        to:
          type: integer
          nullable: true
        per_page:
          type: integer
        last_page:
          type: integer
        total:
          type: integer
        path:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
          example: insufficient_scope
        message:
          type: string
          example: 'Token is missing the required ability: orders:read.'
        request_id:
          type: string
          nullable: true
  responses:
    Unauthorized:
      description: Token ausente, inválido ou expirado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: Invalid or expired token.
            request_id: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token opaco no formato `ticto_live_...` (produção) ou `ticto_test_...`
        (sandbox). Enviado como `Authorization: Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.