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

# List withdrawals

> Retrieve a paginated list of withdrawals with optional filters.



## OpenAPI

````yaml GET /v1/withdrawals
openapi: 3.1.0
info:
  title: YuvexPay API
  description: >-
    The YuvexPay API allows you to accept payments, process withdrawals, manage
    products and customers programmatically. All API access is over HTTPS and
    uses JSON request/response bodies.
  version: 1.0.0
  contact:
    name: YuvexPay Support
    email: support@yuvexpay.com
    url: https://docs.yuvexpay.com
servers:
  - url: https://api.yuvexpay.com
    description: >-
      Same base URL serves both sandbox and production. Send a `ypk_test_*` key
      for sandbox or a `ypk_live_*` key for production.
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Inspect the API key in use
  - name: Payments
    description: Create and manage payments
  - name: Withdrawals
    description: Create and manage withdrawals
  - name: Products
    description: Manage product catalog
  - name: Customers
    description: Manage customer records
  - name: Documents
    description: Generate receipts and statements
  - name: Balance
    description: Inspect the current account balance
paths:
  /v1/withdrawals:
    get:
      tags:
        - Withdrawals
      summary: List withdrawals
      description: Retrieve a paginated list of withdrawals with optional filters.
      operationId: listWithdrawals
      parameters:
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/WithdrawalStatus'
          description: Filter by withdrawal status.
        - name: method
          in: query
          schema:
            type: string
            enum:
              - PIX
          description: >-
            Filter by withdrawal method. Public withdrawals currently support
            PIX only.
        - name: currency
          in: query
          schema:
            type: string
            enum:
              - BRL
          description: Filter by currency. Public withdrawals currently support BRL only.
        - name: startDate
          in: query
          schema:
            type: string
            format: date-time
          description: Start of date range (ISO 8601).
        - name: endDate
          in: query
          schema:
            type: string
            format: date-time
          description: End of date range (ISO 8601).
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Withdrawals listed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  withdrawals:
                    type: array
                    items:
                      $ref: '#/components/schemas/Withdrawal'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    WithdrawalStatus:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - COMPLETED
        - FAILED
        - CANCELLED
      description: Possible withdrawal statuses.
    Withdrawal:
      type: object
      properties:
        id:
          type: string
          format: uuid
        txId:
          type: string
        grossAmount:
          type: number
        feeAmount:
          type: number
        netAmount:
          type: number
        pixKey:
          type: string
          description: >-
            The destination PIX key, masked. The full key is never returned by
            the API once the withdrawal is created.
        pixKeyType:
          type: string
          description: Type of PIX key (CPF, CNPJ, EMAIL, PHONE, RANDOM).
        status:
          $ref: '#/components/schemas/WithdrawalStatus'
        isSandbox:
          type: boolean
        createdAt:
          type: string
          format: date-time
        paymentMethod:
          type: string
          enum:
            - PIX
        currency:
          type: string
          enum:
            - BRL
        processedAt:
          type: string
          format: date-time
          nullable: true
        errorMessage:
          type: string
          nullable: true
          description: >-
            Human-readable failure message. Treat as opaque text and surface
            only to internal operators.
    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        totalPages:
          type: integer
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
            details:
              type: object
              description: Additional error context.
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number for pagination.
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of items per page (1-100).
  responses:
    Unauthorized:
      description: Missing or invalid authentication token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_API_KEY
              message: Invalid or revoked API key
    RateLimited:
      description: Rate limit exceeded.
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Request limit per window.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Remaining requests in window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMIT_EXCEEDED
              message: Too many requests
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        YuvexPay API key. Include as `Authorization: Bearer
        ypk_<env>_<kid>_<secret>` where `<env>` is `test` (sandbox) or `live`
        (production). Create and manage keys in the dashboard under **Settings >
        API Keys**.

````