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

# Listar Saques

> Liste todos os saques do usuário com filtros e paginação

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.eyowallet.ru/api/v1/withdraw/list?limit=50&offset=0&status=COMPLETED' \
    -H 'X-API-Key: sua_api_key'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "data": {
      "withdraws": [
        {
          "id": "withdraw_abc123",
          "correlationID": "mistic_transaction_id",
          "value": 10000,
          "status": "COMPLETED",
          "pixKey": "usuario@example.com",
          "description": "Saque para conta pessoal",
          "metadata": {},
          "createdAt": "2024-01-15T10:30:00Z",
          "updatedAt": "2024-01-15T10:30:00Z"
        }
      ],
      "pagination": {
        "total": 1,
        "limit": 50,
        "offset": 0,
        "hasMore": false
      },
      "statistics": {
        "total": 1,
        "completed": 1,
        "pending": 0,
        "failed": 0,
        "totalValue": 10000
      }
    }
  }
  ```
</ResponseExample>

### Parâmetros

<ParamField query="status" type="string">
  Filtrar por status: `PENDING`, `COMPLETED`, `FAILED`.
</ParamField>

<ParamField query="limit" default="50" type="integer">
  Número máximo de resultados a retornar (máximo 100).
</ParamField>

<ParamField query="offset" default="0" type="integer">
  Número de resultados a pular (para paginação).
</ParamField>

### Campos da Resposta

<ResponseField name="withdraws" type="array">
  Lista de saques do usuário.
</ResponseField>

<ResponseField name="pagination" type="object">
  Informações de paginação incluindo total de registros e se há mais páginas.
</ResponseField>

<ResponseField name="statistics" type="object">
  Estatísticas resumidas dos saques, incluindo totais por status e valores.
</ResponseField>

### Permissões Necessárias

Esta rota requer a permissão `read:withdraws`.

### Rate Limiting

* **10 req/s (600 req/min) por API Key**

<Note>
  Esta rota possui cache de 60 segundos para melhorar a performance.
</Note>


## OpenAPI

````yaml GET /api/v1/withdraw/list
openapi: 3.1.0
info:
  title: Eyo Wallet API
  description: >-
    API para integração com a Eyo Wallet - Plataforma de pagamentos PIX para
    desenvolvedores e empresas
  version: 1.0.0
  contact:
    name: Eyo Wallet
    url: https://eyowallet.ru
servers:
  - url: https://api.eyowallet.ru
    description: Servidor de Produção
security:
  - apiKeyAuth: []
tags:
  - name: Payments
    description: Endpoints para criar e gerenciar pagamentos PIX
  - name: Withdraws
    description: Endpoints para criar e gerenciar saques via PIX
  - name: Transfers
    description: Endpoints para transferências internas entre contas Eyo Wallet
  - name: User
    description: Endpoints para informações do usuário e configurações
paths:
  /api/v1/withdraw/list:
    get:
      tags:
        - Withdraws
      summary: Listar Saques
      description: Lista todos os saques do usuário com filtros e paginação
      operationId: listWithdraws
      parameters:
        - name: status
          in: query
          description: Filtrar por status
          schema:
            type: string
            enum:
              - PENDING
              - COMPLETED
              - FAILED
        - name: limit
          in: query
          description: Número máximo de resultados (máximo 100)
          schema:
            type: integer
            default: 50
            maximum: 100
        - name: offset
          in: query
          description: Número de resultados a pular (para paginação)
          schema:
            type: integer
            default: 0
      responses:
        '200':
          description: Lista de saques
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWithdrawsResponse'
components:
  schemas:
    ListWithdrawsResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            withdraws:
              type: array
              items:
                $ref: '#/components/schemas/WithdrawItem'
            pagination:
              $ref: '#/components/schemas/Pagination'
            statistics:
              $ref: '#/components/schemas/WithdrawsStatistics'
    WithdrawItem:
      type: object
      properties:
        id:
          type: string
        correlationID:
          type: string
        value:
          type: integer
        status:
          type: string
          enum:
            - PENDING
            - COMPLETED
            - FAILED
        pixKey:
          type: string
        description:
          type: string
        metadata:
          type: object
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        hasMore:
          type: boolean
    WithdrawsStatistics:
      type: object
      properties:
        total:
          type: integer
        completed:
          type: integer
        pending:
          type: integer
        failed:
          type: integer
        totalValue:
          type: integer
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key obtida no painel da Eyo Wallet

````