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

# Listar Entregas

> Retorna o histórico de tentativas de entrega de um endpoint —
útil para debugar falhas (status HTTP, sucesso, tentativa, erro).


Lista o **histórico de entregas** de um endpoint — útil para debugar falhas
sem depender de logs no seu próprio backend.

## Filtros

| Filtro             | Aceita                                 | Exemplo                          |
| ------------------ | -------------------------------------- | -------------------------------- |
| `success`          | `true` ou `false`                      | `?success=false`                 |
| `after` / `before` | Cursor opaco retornado em `pagination` | `?after=eyJjcmVhdGVkQXQiOi4uLn0` |
| `limit`            | 1 a 100 (padrão 20)                    | `?limit=50`                      |

**Exemplo:**

```bash theme={null}
# Só entregas que falharam
GET /webhooks/whk_018fa3b56c7d7e30a8b9/deliveries?success=false
```

**Resposta:**

```json theme={null}
{
  "data": [
    {
      "id": "whd_018fa4c96d8e7f209a1c",
      "event": "CHARGE_PAID",
      "eventId": "evt_018fa4c76d8e7f209a1b",
      "statusCode": 200,
      "success": true,
      "attempt": 1,
      "error": null,
      "createdAt": "2026-04-19T18:34:56.000Z"
    },
    {
      "id": "whd_018fa4c86d8e7f209a1a",
      "event": "CHARGE_PAID",
      "eventId": "evt_018fa4c56d8e7f209a19",
      "statusCode": 500,
      "success": false,
      "attempt": 2,
      "error": "request timed out",
      "createdAt": "2026-04-19T18:20:12.000Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "next": null,
    "before": null
  },
  "error": null,
  "success": true
}
```

<Tip>
  Se `success` estiver `false` e `attempt` já for `3`, essa entrega não será
  tentada novamente. Corrija o problema no seu endpoint e aguarde o próximo
  evento — não há uma rota para forçar reenvio de uma entrega específica
  pelo lado do merchant.
</Tip>


## OpenAPI

````yaml GET /webhooks/{id}/deliveries
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}/deliveries:
    get:
      tags:
        - Webhooks
      summary: Listar entregas
      description: |
        Retorna o histórico de tentativas de entrega de um endpoint —
        útil para debugar falhas (status HTTP, sucesso, tentativa, erro).
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: whk_018fa3b56c7d7e30a8b9
        - name: success
          in: query
          required: false
          description: Filtra por entregas bem-sucedidas (`true`) ou com falha (`false`).
          schema:
            type: boolean
        - $ref: '#/components/parameters/After'
        - $ref: '#/components/parameters/Before'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Lista paginada de entregas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDeliveryListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    After:
      name: after
      in: query
      required: false
      description: >-
        Cursor opaco (do campo `pagination.next` da resposta anterior) para
        buscar a página seguinte.
      schema:
        type: string
    Before:
      name: before
      in: query
      required: false
      description: >-
        Cursor opaco (do campo `pagination.before` da resposta anterior) para
        buscar a página anterior.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      required: false
      description: Quantidade máxima de itens por página (1 a 100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    WebhookDeliveryListResponse:
      type: object
      required:
        - data
        - pagination
        - error
        - success
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WebhookDelivery'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    WebhookDelivery:
      type: object
      required:
        - id
        - event
        - eventId
        - statusCode
        - success
        - attempt
        - createdAt
      properties:
        id:
          type: string
          example: whd_018fa4c96d8e7f209a1c
        event:
          $ref: '#/components/schemas/WebhookEvent'
        eventId:
          type: string
          description: >-
            ID do evento entregue (`evt_...`) — o mesmo enviado como `id` no
            payload.
          example: evt_018fa4c76d8e7f209a1b
        statusCode:
          type: integer
          nullable: true
          description: >-
            Status HTTP retornado pelo seu endpoint (null se timeout/erro de
            rede).
          example: 200
        success:
          type: boolean
          example: true
        attempt:
          type: integer
          description: Número da tentativa (1 a 3).
          example: 1
        error:
          type: string
          nullable: true
          description: Mensagem de erro, se houver (timeout, erro de rede, etc.).
          example: null
        createdAt:
          type: string
          format: date-time
          example: '2026-04-19T18:34:56.000Z'
    CursorPagination:
      type: object
      required:
        - hasMore
        - next
        - before
      description: |
        Metadados de paginação bidirecional (usado por Checkout Transparente
        e Webhooks). `next`/`before` são cursores opacos — passe-os de volta
        em `after`/`before` para navegar.
      properties:
        hasMore:
          type: boolean
          description: Indica se existem mais itens após esta página.
          example: true
        next:
          type: string
          nullable: true
          description: Cursor para a próxima página, ou `null` se for a última.
          example: eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTE5In0
        before:
          type: string
          nullable: true
          description: Cursor para a página anterior, ou `null` se for a primeira.
          example: null
    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
    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).

````