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

# Listar saques

> Liste e filtre seus saques

Retorna uma lista paginada de saques com suporte a filtros de status, data e ID externo.


## OpenAPI

````yaml api-reference/openapi.json GET /v1/cashouts
openapi: 3.1.1
info:
  title: Safefy - Pix Gateway
  description: >

    ## Introducao


    **Seu parceiro financeiro de confianca.**


    Nos somos a Safefy, uma plataforma especializada em solucoes de pagamento
    PIX. Com um servico personalizado e focado nas suas necessidades, estamos
    prontos para apoiar sua empresa em cada etapa do processo.


    - Conte com o **PIX** como metodo de pagamento rapido, seguro e alinhado com
    as melhores praticas de conformidade e prevencao a fraudes.

    - Gerencie suas financas de forma simples e acessivel por meio de uma
    interface completa e intuitiva.

    - Nosso time de suporte esta sempre disponivel para oferecer um atendimento
    exclusivo e eficiente.


    ## Precisa de Ajuda?


    A equipe da Safefy quer garantir que sua integracao seja um sucesso. Se
    tiver duvidas ou precisar de suporte, nao hesite em nos contatar:


    **suporte@safefypay.com.br**


    ---


    ## Valores Monetarios


    Todos os valores monetarios sao representados em **centavos** (menor unidade
    da moeda).


    | Valor Real | Valor na API |

    |------------|--------------|

    | R$ 1,00    | 100          |

    | R$ 10,50   | 1050         |

    | R$ 100,00  | 10000        |
  contact:
    name: Suporte Safefy
    email: suporte@safefypay.com.br
  version: v1
servers:
  - url: https://api-payment.safefypay.com.br
    description: API de Pagamentos Safefy
security:
  - bearerAuth: []
tags:
  - name: Autenticacao
    description: Endpoints de autenticacao OAuth2
  - name: Transacoes
    description: Gerenciamento de transacoes PIX
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Saldo
    description: Consulta de saldo e volumes
  - name: Saques
    description: Solicitacao e gerenciamento de saques
  - name: Disputas
    description: Consulta de disputas e envio de defesa
paths:
  /v1/cashouts:
    get:
      tags:
        - Saques
      summary: Listar saques
      description: Retorna uma lista paginada de saques com suporte a filtros.
      operationId: listCashouts
      parameters:
        - name: page
          in: query
          description: Numero da pagina
          schema:
            type: integer
            default: 1
            example: 1
        - name: pageSize
          in: query
          description: 'Itens por pagina (max: 100)'
          schema:
            type: integer
            default: 20
            example: 20
        - name: status
          in: query
          description: Filtrar por status
          schema:
            type: string
            enum:
              - Pending
              - Processing
              - Completed
              - Failed
              - Rejected
              - Cancelled
            example: Completed
        - name: startDate
          in: query
          description: Data inicial (ISO 8601)
          schema:
            type: string
            format: date-time
            example: '2025-01-01T00:00:00Z'
        - name: endDate
          in: query
          description: Data final (ISO 8601)
          schema:
            type: string
            format: date-time
            example: '2025-01-31T23:59:59Z'
      responses:
        '200':
          description: Lista de saques
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCashoutsResponse'
              example:
                data:
                  items:
                    - id: b2c3d4e5-f6a7-8901-bcde-f23456789012
                      amount: 50000
                      fee: 200
                      netAmount: 49800
                      status: Completed
                      pixKeyType: CPF
                      pixKey: '***456789**'
                      endToEndId: E12345678202501151600xyz789abc012
                      crypto: null
                      failureReason: null
                      requestedAt: '2025-01-15T16:00:00Z'
                      completedAt: '2025-01-15T16:05:00Z'
                      createdAt: '2025-01-15T16:00:00Z'
                  page: 1
                  pageSize: 20
                  totalItems: 1
                  totalPages: 1
                  hasNextPage: false
                  hasPreviousPage: false
                message: null
                error: null
        '401':
          description: Nao autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCashoutsResponse'
              example:
                data: null
                message: null
                error:
                  message: Token invalido ou expirado.
                  code: unauthorized
components:
  schemas:
    ListCashoutsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PaginatedCashouts'
        message:
          type: string
          nullable: true
        error:
          $ref: '#/components/schemas/ApiErrorResponse'
    PaginatedCashouts:
      type: object
      nullable: true
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CashoutListItem'
        page:
          type: integer
          example: 1
        pageSize:
          type: integer
          example: 20
        totalItems:
          type: integer
          example: 10
        totalPages:
          type: integer
          example: 1
        hasNextPage:
          type: boolean
          example: false
        hasPreviousPage:
          type: boolean
          example: false
    ApiErrorResponse:
      type: object
      nullable: true
      properties:
        message:
          type: string
          description: Mensagem de erro
          example: Token invalido ou expirado.
        code:
          type: string
          description: Codigo do erro
          example: unauthorized
    CashoutListItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: b2c3d4e5-f6a7-8901-bcde-f23456789012
        amount:
          type: integer
          example: 50000
        fee:
          type: integer
          example: 200
        netAmount:
          type: integer
          example: 49800
        status:
          type: string
          example: Completed
        pixKeyType:
          type: string
          nullable: true
          example: CPF
        pixKey:
          type: string
          nullable: true
          example: '***456789**'
        endToEndId:
          type: string
          nullable: true
          example: E12345678202501151600xyz789abc012
        crypto:
          $ref: '#/components/schemas/CashoutCryptoData'
        failureReason:
          type: string
          nullable: true
          example: null
        requestedAt:
          type: string
          format: date-time
          example: '2025-01-15T16:00:00Z'
        completedAt:
          type: string
          format: date-time
          nullable: true
          example: '2025-01-15T16:05:00Z'
        createdAt:
          type: string
          format: date-time
          example: '2025-01-15T16:00:00Z'
    CashoutCryptoData:
      type: object
      nullable: true
      description: Destino de saque cripto via XGate. O endereço é sempre mascarado.
      properties:
        walletAddress:
          type: string
          description: Endereço da carteira mascarado.
          example: 0x1234…cdef
        networkSymbol:
          type: string
          description: Rede blockchain do saque.
          example: BEP-20
        cryptoSymbol:
          type: string
          description: Criptomoeda liquidada.
          example: USDT
        transactionId:
          type: string
          nullable: true
          description: ID da transação retornado pela XGate, quando disponível.
          example: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token JWT obtido via /v1/auth/token

````