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

# Listar Saques

> Lista os saques do merchant com filtro opcional por status.

Lista os saques do merchant com paginação bidirecional e filtro opcional por status.

## Filtros

| Filtro             | Aceita                                         |
| ------------------ | ---------------------------------------------- |
| `status`           | `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` |
| `after` / `before` | Cursor opaco retornado em `pagination`         |
| `limit`            | 1 a 100 (padrão 20)                            |

## Exemplos

```bash theme={null}
# Saques completos
GET /withdrawals?status=COMPLETED&limit=50

# Saques que falharam para investigação
GET /withdrawals?status=FAILED
```

<Tip>
  A listagem traz os campos essenciais. Para ver `batchId` em detalhe, use
  [`GET /withdrawals/{id}`](/pages/withdrawals/get).
</Tip>


## OpenAPI

````yaml GET /withdrawals
openapi: 3.1.0
info:
  title: API Liquerapay
  description: |
    API pública da Liquerapay para criar cobranças PIX, processar saques,
    gerenciar clientes e receber eventos via webhooks.

    ## Versão Beta

    A v1 está em **beta**. Endpoints e payloads podem sofrer pequenas
    alterações antes da versão estável (1.0). Recomendamos travar a versão
    da sua integração no `package.json` / `requirements.txt` enquanto
    estivermos em beta.

    Não há ambiente de sandbox — todas as chamadas acontecem contra o
    ambiente de produção.

    ## Como começar

    1. Crie sua conta em [app.liquerapay.com](https://app.liquerapay.com)
    2. Gere uma chave de API no painel (`liq_...`)
    3. Faça sua primeira chamada em `https://api.liquerapay.com`
  version: 1.0.0-beta
  contact:
    name: Suporte Liquerapay
    url: https://liquerapay.com
  license:
    name: Proprietary
servers:
  - url: https://api.liquerapay.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Cadastre e gerencie os clientes da sua loja para reutilizar em cobranças.
  - name: Checkout Transparente
    description: >-
      Crie cobranças PIX (QR Code copia-e-cola) direto pela API e gerencie
      devoluções.
  - name: Withdrawals
    description: Solicite saques do saldo disponível para uma chave PIX.
  - name: Webhooks
    description: Cadastre URLs para receber eventos da Liquerapay em tempo real.
paths:
  /withdrawals:
    get:
      tags:
        - Withdrawals
      summary: Listar saques
      description: Lista os saques do merchant com filtro opcional por status.
      parameters:
        - $ref: '#/components/parameters/After'
        - $ref: '#/components/parameters/Before'
        - $ref: '#/components/parameters/Limit'
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/WithdrawalStatus'
      responses:
        '200':
          description: Lista paginada de saques.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithdrawalListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    After:
      name: after
      in: query
      required: false
      description: >-
        Cursor opaco (do campo `pagination.next` da resposta anterior) para
        buscar a página seguinte.
      schema:
        type: string
    Before:
      name: before
      in: query
      required: false
      description: >-
        Cursor opaco (do campo `pagination.before` da resposta anterior) para
        buscar a página anterior.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      required: false
      description: Quantidade máxima de itens por página (1 a 100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    WithdrawalStatus:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - COMPLETED
        - FAILED
      description: |
        - `PENDING`: solicitado, aguardando processamento
        - `PROCESSING`: em processamento no PSP
        - `COMPLETED`: PIX enviado com sucesso
        - `FAILED`: falhou (ver `failedReason`)
      example: COMPLETED
    WithdrawalListResponse:
      type: object
      required:
        - data
        - pagination
        - error
        - success
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WithdrawalListItem'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    WithdrawalListItem:
      type: object
      required:
        - id
        - amount
        - fee
        - status
        - createdAt
      properties:
        id:
          type: string
          example: with_018f91023e4a7d20e5f6
        amount:
          type: integer
          example: 5000
        fee:
          type: integer
          example: 50
        status:
          $ref: '#/components/schemas/WithdrawalStatus'
        failedReason:
          type: string
          nullable: true
          description: Motivo da falha quando `status = FAILED`.
          example: null
        createdAt:
          type: string
          format: date-time
          example: '2026-04-19T20:00:00.000Z'
    CursorPagination:
      type: object
      required:
        - hasMore
        - next
        - before
      description: |
        Metadados de paginação bidirecional (usado por Checkout Transparente
        e Webhooks). `next`/`before` são cursores opacos — passe-os de volta
        em `after`/`before` para navegar.
      properties:
        hasMore:
          type: boolean
          description: Indica se existem mais itens após esta página.
          example: true
        next:
          type: string
          nullable: true
          description: Cursor para a próxima página, ou `null` se for a última.
          example: eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTE5In0
        before:
          type: string
          nullable: true
          description: Cursor para a página anterior, ou `null` se for a primeira.
          example: null
    Error:
      type: object
      required:
        - error
        - message
        - success
      properties:
        error:
          type: string
          description: >-
            Código do erro (ex.: `VALIDATION_ERROR`, `UNAUTHORIZED`,
            `NOT_FOUND`).
          example: VALIDATION_ERROR
        message:
          type: string
          description: Mensagem amigável descrevendo o erro.
          example: 'amount: deve ser um número inteiro positivo'
        success:
          type: boolean
          enum:
            - false
          example: false
  responses:
    Unauthorized:
      description: Falha de autenticação (token inválido, ausente ou revogado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: UNAUTHORIZED
            message: Token inválido ou ausente
            success: false
    Forbidden:
      description: Acesso negado para esta operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: FORBIDDEN
            message: Saques estão temporariamente bloqueados para este merchant
            success: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key ou JWT
      description: |
        Autentique suas requisições enviando o token no header
        `Authorization: Bearer <token>`.

        O token pode ser:

        - Uma **API key** com prefixo `liq_`, gerada em
          [Dashboard Liquerapay → Configurações → API Keys](https://app.liquerapay.com).
        - Um **JWT** retornado pelo login do dashboard (uso interno).

        Não há distinção de ambiente — toda chave vale para o único
        ambiente disponível (produção).

````