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

# Obter Saque

> Retorna o status e detalhes de um saque, incluindo `failedReason`
caso o saque tenha falhado.


Retorna o status e detalhes de um saque.

**Exemplo de resposta (saque concluído):**

```json theme={null}
{
  "data": {
    "id": "with_018f91023e4a7d20e5f6",
    "amount": 5000,
    "fee": 50,
    "status": "COMPLETED",
    "batchId": "batch_9f3b1c2d",
    "failedReason": null,
    "createdAt": "2026-04-19T20:00:00.000Z",
    "updatedAt": "2026-04-19T20:01:30.000Z"
  },
  "error": null,
  "success": true
}
```

**Exemplo (saque que falhou):**

```json theme={null}
{
  "data": {
    "id": "with_018f91023e4a7d20e5f6",
    "amount": 5000,
    "fee": 50,
    "status": "FAILED",
    "batchId": null,
    "failedReason": "Chave PIX não encontrada na DICT",
    "createdAt": "2026-04-19T20:00:00.000Z",
    "updatedAt": "2026-04-19T20:01:15.000Z"
  },
  "error": null,
  "success": true
}
```

<Note>
  Este endpoint **não** devolve `pixKey`/`pixKeyType` — só os campos de
  status e conciliação. Quando o saque falha, **o saldo é restaurado**
  automaticamente (de `pending` volta para `available`).
</Note>


## OpenAPI

````yaml GET /withdrawals/{id}
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/{id}:
    get:
      tags:
        - Withdrawals
      summary: Obter saque
      description: |
        Retorna o status e detalhes de um saque, incluindo `failedReason`
        caso o saque tenha falhado.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: with_018f91023e4a7d20e5f6
      responses:
        '200':
          description: Saque encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithdrawalDetailResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    WithdrawalDetailResponse:
      type: object
      required:
        - data
        - error
        - success
      properties:
        data:
          $ref: '#/components/schemas/WithdrawalDetail'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    WithdrawalDetail:
      type: object
      required:
        - id
        - amount
        - fee
        - status
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          example: with_018f91023e4a7d20e5f6
        amount:
          type: integer
          example: 5000
        fee:
          type: integer
          example: 50
        status:
          $ref: '#/components/schemas/WithdrawalStatus'
        batchId:
          type: string
          nullable: true
          description: >-
            ID do lote no PSP, usado para reconciliação — preenchido quando o
            saque é enviado.
          example: null
        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'
        updatedAt:
          type: string
          format: date-time
          example: '2026-04-19T20:01:30.000Z'
    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
    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
  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
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: NOT_FOUND
            message: Customer não encontrado
            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).

````