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

# Listar saques

> Retorna uma lista paginada de saques da sua conta, com suporte a diversos filtros por status, valor, data e identificadores.



## OpenAPI

````yaml GET /withdrawals
openapi: 3.1.0
info:
  title: Pluggou API
  description: API de intermediação de pagamentos da Pluggou
  version: 1.0.0
servers:
  - url: https://api.pluggoutech.com/api
security:
  - publicKey: []
    secretKey: []
paths:
  /withdrawals:
    get:
      tags:
        - Transferências
      summary: Listar saques
      description: >-
        Retorna uma lista paginada de saques da sua conta, com suporte a
        diversos filtros por status, valor, data e identificadores.
      operationId: listWithdrawals
      parameters:
        - name: id
          in: query
          description: Busca exata pelo UUID do saque.
          schema:
            type: string
            format: uuid
        - name: e2e_id
          in: query
          description: Busca exata pelo identificador end-to-end.
          schema:
            type: string
        - name: amount_min
          in: query
          description: Valor mínimo em centavos.
          schema:
            type: integer
        - name: amount_max
          in: query
          description: Valor máximo em centavos.
          schema:
            type: integer
        - name: status
          in: query
          description: Filtra por status do saque.
          schema:
            type: string
            enum:
              - pending
              - approved
              - paid
              - failed
              - canceled
              - refunded
          example: paid
        - name: paid_at_min
          in: query
          description: Data/hora mínima de pagamento no formato `Y-m-d H:i:s` (UTC-3).
          schema:
            type: string
        - name: paid_at_max
          in: query
          description: Data/hora máxima de pagamento no formato `Y-m-d H:i:s` (UTC-3).
          schema:
            type: string
        - name: created_at_min
          in: query
          description: Data/hora mínima de criação no formato `Y-m-d H:i:s` (UTC-3).
          schema:
            type: string
          example: '2026-01-01 00:00:00'
        - name: created_at_max
          in: query
          description: Data/hora máxima de criação no formato `Y-m-d H:i:s` (UTC-3).
          schema:
            type: string
          example: '2026-01-31 23:59:59'
        - name: page
          in: query
          description: 'Página da listagem (padrão: 1).'
          schema:
            type: integer
            default: 1
          example: 1
      responses:
        '200':
          description: Saques listados com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWithdrawalsSuccess'
              example:
                success: true
                message: Saques listados com sucesso.
                data:
                  withdrawals:
                    - id: e5f6a1b2-c3d4-7890-efgh-4567890abcde
                      e2e_id: E12345678202301011234abcdefghijkl
                      amount: 50000
                      liquid_amount: 50000
                      pix_type: cpf
                      pix_key: '12345678909'
                      status: paid
                      paid_at: '2026-01-29 12:00:00'
                      created_at: '2026-01-29 11:58:00'
                    - id: f6a1b2c3-d4e5-7890-fghi-567890abcdef
                      e2e_id: null
                      amount: 30000
                      liquid_amount: 30000
                      pix_type: email
                      pix_key: usuario@email.com
                      status: pending
                      paid_at: null
                      created_at: '2026-01-29 10:30:00'
                  pagination:
                    current_page: 1
                    last_page: 3
                    per_page: 10
                    total: 25
        '401':
          description: Erro de autenticação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
              examples:
                credenciais_ausentes:
                  summary: Credenciais ausentes
                  value:
                    error: Credenciais inválidas
                    message: Chave pública e chave privada são obrigatórias
                credenciais_invalidas:
                  summary: Credenciais inválidas
                  value:
                    error: Credenciais inválidas
                    message: Chave não encontrada ou inativa
        '403':
          description: Erro de permissão
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                conta_nao_aprovada:
                  summary: Conta não aprovada
                  value:
                    success: false
                    message: >-
                      Sua conta precisa estar aprovada para usar esta
                      funcionalidade.
                    data: null
                conta_bloqueada:
                  summary: Conta bloqueada
                  value:
                    success: false
                    message: Sua conta está bloqueada.
                    data: null
        '422':
          description: Erro de validação nos filtros
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
              example:
                success: false
                message: Erro de validação nos filtros fornecidos
                data:
                  errors:
                    status:
                      - >-
                        Status inválido. Valores aceitos: pending, approved,
                        paid, failed, canceled, refunded.
components:
  schemas:
    ListWithdrawalsSuccess:
      type: object
      properties:
        success:
          type: boolean
          description: Indica se a operação foi bem-sucedida.
        message:
          type: string
          description: Mensagem descritiva do resultado.
        data:
          type: object
          properties:
            withdrawals:
              type: array
              description: Lista de saques retornados.
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Identificador único do saque (UUID).
                  e2e_id:
                    type: string
                    nullable: true
                    description: >-
                      Identificador end-to-end do PIX. `null` se ainda não
                      processado.
                  amount:
                    type: integer
                    description: Valor total do saque em centavos.
                  liquid_amount:
                    type: integer
                    description: Valor líquido transferido em centavos.
                  pix_type:
                    type: string
                    description: Tipo da chave PIX de destino.
                  pix_key:
                    type: string
                    description: Valor da chave PIX de destino.
                  status:
                    type: string
                    enum:
                      - pending
                      - approved
                      - paid
                      - failed
                      - canceled
                      - refunded
                    description: Status atual do saque.
                  paid_at:
                    type: string
                    nullable: true
                    description: Data/hora do pagamento. `null` se não pago.
                  created_at:
                    type: string
                    description: Data/hora de criação do saque.
            pagination:
              type: object
              description: Dados de paginação.
              properties:
                current_page:
                  type: integer
                  description: Página atual.
                last_page:
                  type: integer
                  description: Última página disponível.
                per_page:
                  type: integer
                  description: Quantidade de registros por página.
                total:
                  type: integer
                  description: Total de registros encontrados.
    AuthErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Tipo do erro de autenticação.
        message:
          type: string
          description: Mensagem descritiva do erro.
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Sempre `false` em caso de erro.
        message:
          type: string
          description: Mensagem descritiva do erro.
        data:
          type: object
          nullable: true
          description: Sempre `null` em erros simples.
    ValidationErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Sempre `false` em caso de erro.
        message:
          type: string
          description: Mensagem descritiva do erro.
        data:
          type: object
          properties:
            errors:
              type: object
              description: >-
                Objeto onde cada chave é o nome do campo e o valor é um array
                com as mensagens de erro.
              additionalProperties:
                type: array
                items:
                  type: string
  securitySchemes:
    publicKey:
      type: apiKey
      in: header
      name: X-Public-Key
      description: 'Sua chave pública de acesso à API. Ex: `pk_live_abc123def456...`'
    secretKey:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: 'Sua chave secreta de acesso à API. Ex: `sk_live_xyz789ghi012...`'

````