> ## 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.

# Consultar saque

> Consulta os dados de um saque específico pelo seu identificador único (UUID).



## OpenAPI

````yaml GET /withdrawals/{id}
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/{id}:
    get:
      tags:
        - Transferências
      summary: Consultar saque
      description: >-
        Consulta os dados de um saque específico pelo seu identificador único
        (UUID).
      operationId: getWithdrawal
      parameters:
        - name: id
          in: path
          required: true
          description: Identificador único do saque (UUID).
          schema:
            type: string
            format: uuid
          example: e5f6a1b2-c3d4-7890-efgh-4567890abcde
      responses:
        '200':
          description: Saque encontrado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWithdrawalSuccess'
              example:
                success: true
                message: Saque encontrado com sucesso.
                data:
                  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'
        '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
        '404':
          description: Saque não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                message: Saque não encontrado.
                data: null
components:
  schemas:
    GetWithdrawalSuccess:
      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:
            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 no formato `YYYY-MM-DD HH:mm:ss`. `null`
                se não pago.
            created_at:
              type: string
              description: Data/hora de criação no formato `YYYY-MM-DD HH:mm:ss`.
    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.
  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...`'

````