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

> Retorna os detalhes de um endpoint de webhook (sem `secret`).

Retorna os detalhes de um endpoint de webhook específico.

**Exemplo de resposta:**

```json theme={null}
{
  "data": {
    "id": "whk_018fa3b56c7d7e30a8b9",
    "url": "https://meusite.com/webhooks/liquerapay",
    "events": ["CHARGE_PAID", "REFUND_COMPLETED", "REFUND_FAILED"],
    "active": true,
    "createdAt": "2026-04-19T18:00:00.000Z",
    "updatedAt": "2026-04-19T18:00:00.000Z"
  },
  "error": null,
  "success": true
}
```

<Note>
  Assim como na listagem, o `secret` **nunca** aparece aqui — ele só é
  retornado uma vez, na criação do endpoint.
</Note>

`404 NOT_FOUND` se o endpoint não existir ou pertencer a outro merchant.


## OpenAPI

````yaml GET /webhooks/{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:
  /webhooks/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: whk_018fa3b56c7d7e30a8b9
    get:
      tags:
        - Webhooks
      summary: Obter endpoint
      description: Retorna os detalhes de um endpoint de webhook (sem `secret`).
      responses:
        '200':
          description: Endpoint encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookGetResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    WebhookGetResponse:
      type: object
      required:
        - data
        - error
        - success
      properties:
        data:
          $ref: '#/components/schemas/WebhookDetail'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    WebhookDetail:
      allOf:
        - $ref: '#/components/schemas/WebhookListItem'
        - type: object
          required:
            - updatedAt
          properties:
            updatedAt:
              type: string
              format: date-time
              example: '2026-04-19T18:00:00.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
    WebhookListItem:
      type: object
      required:
        - id
        - url
        - events
        - active
        - createdAt
      properties:
        id:
          type: string
          example: whk_018fa3b56c7d7e30a8b9
        url:
          type: string
          example: https://meusite.com/webhooks/liquerapay
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          example:
            - CHARGE_PAID
            - REFUND_COMPLETED
            - REFUND_FAILED
        active:
          type: boolean
          description: Fica `false` automaticamente após muitas falhas de entrega.
          example: true
        createdAt:
          type: string
          format: date-time
          example: '2026-04-19T18:00:00.000Z'
    WebhookEvent:
      type: string
      enum:
        - CHARGE_PAID
        - CHARGE_EXPIRED
        - REFUND_COMPLETED
        - REFUND_FAILED
        - WITHDRAWAL_COMPLETED
        - WITHDRAWAL_FAILED
        - CHECKOUT_PAID
        - CHECKOUT_REFUNDED
      description: >
        - `CHARGE_PAID`: cobrança PIX (Checkout Transparente) foi paga

        - `CHARGE_EXPIRED`: reservado — nenhum job dispara este evento hoje

        - `REFUND_COMPLETED`: devolução confirmada pelo PSP

        - `REFUND_FAILED`: devolução falhou

        - `WITHDRAWAL_COMPLETED`: saque concluído

        - `WITHDRAWAL_FAILED`: saque falhou ou foi devolvido

        - `CHECKOUT_PAID`: cobrança de Checkout Hospedado / link de pagamento
        foi paga

        - `CHECKOUT_REFUNDED`: cobrança de Checkout Hospedado / link de
        pagamento foi devolvida
      example: CHARGE_PAID
  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).

````