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

# Listar saques

> Lista os saques mais recentes da conta. Exige o escopo `pix:withdraw`.

> [!NOTE]
>
> Exige uma chave de API com o escopo `pix:withdraw`. Retorna os 100 saques mais recentes da conta, do mais novo para o mais antigo.


## OpenAPI

````yaml GET /v1/public/pix/withdrawals
openapi: 3.1.0
info:
  title: ZynPay Public API
  version: '1.0'
  description: >
    API pública da ZynPay para gerar cobranças Pix e consultar saldo com uma
    chave de API.

    Todo valor monetário é um inteiro em centavos (R$ 10,00 = `1000`).
  license:
    name: Proprietary
servers:
  - url: https://api.zynpay.com.br
security:
  - apiKeyAuth: []
tags:
  - name: Cobranças
    description: Criar e consultar cobranças Pix
  - name: Saques
    description: Solicitar e consultar saques Pix
  - name: Saldo
    description: Consultar o saldo da conta
paths:
  /v1/public/pix/withdrawals:
    get:
      tags:
        - Saques
      summary: Listar saques
      description: Lista os saques mais recentes da conta. Exige o escopo `pix:withdraw`.
      operationId: listWithdrawals
      responses:
        '200':
          description: Lista de saques
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Withdrawal'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Withdrawal:
      type: object
      required:
        - id
        - status
        - amountCents
        - feeCents
        - netAmountCents
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          description: ID único do saque na ZynPay.
        status:
          type: string
          enum:
            - requested
            - under_review
            - approved
            - paid
            - rejected
            - cancelled
          description: |
            `requested` — aguardando análise.
            `under_review` — em análise manual.
            `approved` — aprovado, aguardando envio do Pix.
            `paid` — Pix enviado ao destinatário.
            `rejected` — recusado (veja `reason`).
            `cancelled` — cancelado.
        amountCents:
          type: integer
          description: Valor bruto solicitado
          em centavos.: null
        feeCents:
          type: integer
          description: Taxa de saque
          em centavos.: null
        netAmountCents:
          type: integer
          description: amountCents - feeCents. Valor efetivamente enviado ao destinatário.
        reason:
          type:
            - string
            - 'null'
          description: Motivo informado quando o saque é rejeitado ou cancelado.
        createdAt:
          type: string
          format: date-time
        paidAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Preenchido quando o status muda para `paid`.
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
              example: ACCOUNT_NOT_VERIFIED
            message:
              type: string
            fields:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            requestId:
              type: string
  responses:
    Unauthorized:
      description: Chave de API ausente, inválida, revogada ou expirada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Conta não verificada, ou a chave não tem o escopo necessário
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: zpk_live_...
      description: Chave de API criada em Integrações → Chaves de API no painel.

````

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