> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeriqpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar endpoints de webhook

> Lista os endpoints configurados

Lista todos os endpoints da conta. O segredo nunca é incluído.

## Autenticação

Todas as rotas exigem uma API Key no header `X-API-Key`. A chave deve começar com `zeriq_`.

```http theme={null}
X-API-Key: zeriq_sua_chave
```

```bash cURL theme={null}
curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/list" \
  -H "X-API-Key: zeriq_sua_chave"
```

## Referência

* **Método:** `GET`
* **Rota:** `/v1/webhooks/list`
* **Escopo:** `webhooks.read`
* **Resposta de sucesso:** `200 OK`

Use esta rota para montar telas de configuração ou validar quais endpoints estão ativos.

### Exemplo de resposta

```json theme={null}
{"success":true,"data":[{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}]}
```

### Erros comuns

* `400`: URL, eventos ou body inválidos.
* `401`: API Key ausente ou inválida.
* `403`: a chave não possui o escopo `webhooks.read`.
* `404`: endpoint não encontrado ou não pertence à conta.


## OpenAPI

````yaml GET /v1/webhooks/list
openapi: 3.1.0
info:
  title: ZeriqPay API
  description: >-
    Referência da API v1 da ZeriqPay. As rotas de gerenciamento de webhooks não
    fazem parte desta documentação.
  version: 1.0.0
  contact:
    name: ZeriqPay
    url: https://api.zeriqpay.com.br
servers:
  - url: https://api.zeriqpay.com.br
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Conta
    description: Dados, taxas e limites da conta
  - name: Pagamentos PIX
    description: Cobranças PIX
  - name: Transações
    description: Consulta de transações
  - name: Transferências
    description: Saídas PIX, cripto e internas
  - name: Reembolsos
    description: Reembolsos de cobranças
  - name: Disputas MED
    description: Consulta e envio de evidências MED
  - name: Webhooks
    description: Cadastro e configuração dos endpoints de webhook
paths:
  /v1/webhooks/list:
    get:
      tags:
        - Webhooks
      summary: Listar endpoints de webhook
      description: |-
        Lista os endpoints de webhook da conta. O segredo não é retornado.

        **Escopo necessário:** `webhooks.read`.
      operationId: listWebhookEndpoints
      responses:
        '200':
          description: Lista de endpoints sem segredos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointListResponse'
              example:
                success: true
                data:
                  - id: cmid_webhook
                    name: Pagamentos
                    url: https://app.exemplo.com/webhooks/zeriqpay
                    events:
                      - payment.paid
                      - payment.failed
                    active: true
                    lastDeliveryAt: null
                    createdAt: '2026-10-28T12:00:00.000Z'
                    updatedAt: '2026-10-28T12:00:00.000Z'
        '400':
          description: Corpo ou parâmetros inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                success: false
                message: Dados inválidos.
        '401':
          description: API Key ausente ou inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '403':
          description: Conta bloqueada ou escopo insuficiente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '404':
          description: Webhook não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '429':
          description: Limite específico da rota excedido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    WebhookEndpointListResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEndpoint'
    GenericResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          additionalProperties: true
      required:
        - success
    WebhookEndpoint:
      type: object
      required:
        - id
        - url
        - events
        - active
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          example: cmid_webhook
        name:
          type:
            - string
            - 'null'
          example: Pagamentos
        url:
          type: string
          format: uri
          example: https://app.exemplo.com/webhooks/zeriqpay
        events:
          type: array
          items:
            type: string
            enum:
              - payment.created
              - payment.paid
              - payment.failed
              - payment.pix.expired
              - refund.requested
              - refund.completed
              - refund.failed
              - transfer.created
              - transfer.completed
              - transfer.failed
              - transfer.internal.completed
              - transfer.internal.received
              - med.created
              - med.evidence_sent
              - med.updated
              - webhook.test
          example:
            - payment.paid
            - payment.failed
        active:
          type: boolean
          example: true
        lastDeliveryAt:
          type:
            - string
            - 'null'
          format: date-time
          example: null
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key ZeriqPay iniciada por `zeriq_`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.