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

# Listar Saques

> Consulte o histórico de todas as suas solicitações de saque



## OpenAPI

````yaml GET /api/withdraws
openapi: 3.0.3
info:
  title: Alpa Gateway API
  version: 2.30.0
  description: >-
    Documentação completa da API pública do Alpa Gateway (v2.23.0). Todas as
    rotas requerem autenticação via API Key, exceto validação de cupom, checkout
    público e checkout de assinaturas. Novidades em 2.23.0: sistema de
    assinaturas recorrentes com planos, retry automático e métricas MRR/churn;
    cart abandonment para recuperação de vendas.
  contact:
    email: suporte@usealpa.com
  license:
    name: MIT
servers:
  - url: https://alpa-sistema-api.onrender.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Transações
    description: Gerenciamento de transações de pagamento
  - name: Links de Pagamento
    description: Gerenciamento de links de pagamento
  - name: Produtos
    description: Gerenciamento de produtos do catálogo
  - name: Cupons
    description: Gerenciamento de cupons de desconto
  - name: Webhooks
    description: Gerenciamento de webhooks e assinaturas
  - name: Saldo
    description: Consulta de saldo e movimentações
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Afiliados
    description: Marketplace de afiliados, links rastreáveis e comissões automáticas
  - name: Assinaturas
    description: Planos de assinatura recorrente, checkout público e métricas MRR/churn
  - name: Saques
    description: Solicitações de saque, saldo disponível e métodos de retirada
  - name: Antecipações
    description: Antecipação de recebíveis de transações de cartão parceladas
  - name: Indicações
    description: >-
      Programa de indicações — código de convite, estatísticas e histórico de
      recompensas
paths:
  /api/withdraws:
    get:
      tags:
        - Saques
      summary: Listar Saques
      description: Retorna o historico de solicitacoes de saque do usuario autenticado.
      operationId: listWithdraws
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          description: Pagina atual
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
          description: Resultados por pagina (max. 100)
        - name: status
          in: query
          schema:
            type: string
            enum:
              - PENDING
              - PROCESSING
              - COMPLETED
              - FAILED
              - CANCELLED
          description: Filtrar por status
      responses:
        '200':
          description: Lista de saques retornada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        userId:
                          type: string
                          format: uuid
                        amountCents:
                          type: integer
                          example: 5000
                          description: Valor solicitado em centavos
                        feeCents:
                          type: integer
                          example: 350
                          description: Taxa do saque em centavos
                        netAmount:
                          type: integer
                          example: 4650
                          description: Valor liquido a receber em centavos
                        status:
                          type: string
                          enum:
                            - PENDING
                            - PROCESSING
                            - COMPLETED
                            - FAILED
                            - CANCELLED
                        pixKeyType:
                          type: string
                          enum:
                            - cpf
                            - cnpj
                            - email
                            - phone
                            - random
                          nullable: true
                        pixKey:
                          type: string
                          nullable: true
                        externalId:
                          type: string
                          nullable: true
                        failureReason:
                          type: string
                          nullable: true
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        processedAt:
                          type: string
                          format: date-time
                          nullable: true
                        completedAt:
                          type: string
                          format: date-time
                          nullable: true
                        failedAt:
                          type: string
                          format: date-time
                          nullable: true
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
                      limit:
                        type: integer
                      total:
                        type: integer
                      totalPages:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyAuth: []
components:
  responses:
    Unauthorized:
      description: Não autorizado - API Key inválida ou ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Chave de API obtida através do endpoint /api/credentials. Também aceita
        formato Bearer Token: Authorization: Bearer <api_key>

````