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

# Criar Endpoint

> Cadastra uma URL HTTPS para receber eventos da Liquerapay.

**Importante:** o `secret` retornado é **mostrado apenas uma vez** —
salve em local seguro. Você usará esse secret para validar a
assinatura (`Liquera-Signature`) das requisições recebidas.


Cadastra uma URL HTTPS para receber eventos da Liquerapay e gera a
`secret` — a **chave de assinatura** usada para validar as requisições.

<Card title="Obrigatório" horizontal>
  `url` (HTTPS válido) e `events` (de 1 a 8 eventos que você quer receber —
  ver a [lista completa](/pages/webhooks/reference#eventos-dispon%C3%ADveis)).
</Card>

**Exemplo:**

```json theme={null}
{
  "url": "https://meusite.com/webhooks/liquerapay",
  "events": ["CHARGE_PAID", "REFUND_COMPLETED", "REFUND_FAILED"]
}
```

<Warning>
  O `secret` retornado é **mostrado apenas uma vez**. Salve imediatamente
  em variável de ambiente / cofre. Sem ele você não consegue validar a
  assinatura (`Liquera-Signature`) dos eventos recebidos.
</Warning>

## Recomendações

<AccordionGroup>
  <Accordion title="Use HTTPS com certificado válido" icon="lock">
    Endpoints `http://` ou com certificado autoassinado/expirado serão
    rejeitados.
  </Accordion>

  <Accordion title="Escolha só os eventos que você processa" icon="filter">
    O endpoint recebe **apenas** os eventos listados em `events` — não é
    mais "recebe tudo por padrão". Cadastre um novo endpoint (ou peça
    ajuste) se precisar de um evento novo depois.
  </Accordion>

  <Accordion title="Responda rápido (< 2s)" icon="bolt">
    Faça apenas o mínimo no handler (validar assinatura, registrar evento)
    e processe o resto em **fila assíncrona**. Endpoints lentos sofrem retry
    e, em excesso, são desativados automaticamente.
  </Accordion>

  <Accordion title="Implemente idempotência" icon="shield-check">
    O mesmo evento pode chegar múltiplas vezes. Use o `id` do topo do
    payload (`evt_...`) como chave única.
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml POST /webhooks
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:
    post:
      tags:
        - Webhooks
      summary: Criar endpoint de webhook
      description: |
        Cadastra uma URL HTTPS para receber eventos da Liquerapay.

        **Importante:** o `secret` retornado é **mostrado apenas uma vez** —
        salve em local seguro. Você usará esse secret para validar a
        assinatura (`Liquera-Signature`) das requisições recebidas.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
      responses:
        '201':
          description: Endpoint criado — guarde o `secret`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    CreateWebhookRequest:
      type: object
      required:
        - url
        - events
      additionalProperties: false
      properties:
        url:
          type: string
          format: uri
          maxLength: 2048
          description: URL HTTPS pública que receberá os eventos via `POST`.
          example: https://meusite.com/webhooks/liquerapay
        events:
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/WebhookEvent'
          description: Eventos aos quais este endpoint será inscrito (de 1 a 8).
          example:
            - CHARGE_PAID
            - REFUND_COMPLETED
            - REFUND_FAILED
    CreateWebhookResponse:
      type: object
      required:
        - data
        - error
        - success
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/WebhookListItem'
            - type: object
              required:
                - secret
              properties:
                secret:
                  type: string
                  description: >
                    **Chave de assinatura mostrada apenas uma vez.** Salve em
                    local

                    seguro — será usada para validar o header
                    `Liquera-Signature`

                    das requisições recebidas.
                  example: >-
                    7f3c1d8b2a5e9f0c1d8b2a5e9f0c1d8b2a5e9f0c1d8b2a5e9f0c1d8b2a5e9f0c
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    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
    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'
    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
  responses:
    BadRequest:
      description: Requisição inválida (validação ou regra de negócio).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            validation:
              summary: Erro de validação
              value:
                error: VALIDATION_ERROR
                message: 'amount: deve ser um número inteiro positivo'
                success: false
            business:
              summary: Erro de regra de negócio
              value:
                error: BAD_REQUEST
                message: >-
                  Saldo insuficiente. Disponível 4500 centavos, necessário 5050
                  centavos
                success: false
    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
  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).

````