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

# Listar Mensajes DLQ

> Utilice este endpoint para listar los mensajes actualmente en la dead-letter queue de webhooks, con alcance al tenant del llamador. El tenant se deriva del JWT bearer (claim `tenantId`), nunca de un header de solicitud.

Esta ruta solo se monta cuando la autenticación está habilitada y un inspector de DLQ está configurado. De lo contrario, no se expone y cualquier solicitud es rechazada con 503.



## OpenAPI

````yaml es/openapi/v3-current/ted.yaml get /v1/webhooks/dlq
openapi: 3.0.3
info:
  title: API del Plugin de Transferencia Bancaria (TED)
  description: >-
    API completa para transferencias bancarias brasileñas (TED OUT, TED IN, P2P)
    a través de la plataforma Lerian, incluyendo iniciación de transferencias,
    procesamiento, seguimiento de estado y cancelación.
  version: 1.1.9
servers:
  - url: https://plugin-br-bank-transfer.sandbox.lerian.net
    description: Sandbox (marcador de posición — aún no disponible para acceso público)
security:
  - BearerAuth: []
tags:
  - name: Transfers API
    description: Endpoints para iniciar, procesar, rastrear y cancelar transferencias.
  - name: Webhooks
    description: >-
      Endpoints para registrar y gestionar suscripciones de webhooks con alcance
      al tenant para eventos de transferencia.
  - name: Webhook DLQ
    description: >-
      Endpoints para inspeccionar y reintentar mensajes de la dead-letter queue
      de webhooks.
paths:
  /v1/webhooks/dlq:
    get:
      tags:
        - Webhook DLQ
      summary: Listar Mensajes DLQ
      description: >-
        Utilice este endpoint para listar los mensajes actualmente en la
        dead-letter queue de webhooks, con alcance al tenant del llamador. El
        tenant se deriva del JWT bearer (claim `tenantId`), nunca de un header
        de solicitud.


        Esta ruta solo se monta cuando la autenticación está habilitada y un
        inspector de DLQ está configurado. De lo contrario, no se expone y
        cualquier solicitud es rechazada con 503.
      operationId: listDLQMessages
      parameters:
        - name: limit
          in: query
          required: false
          description: Número máximo de mensajes a devolver.
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - name: offset
          in: query
          required: false
          description: Número de mensajes a omitir para paginación.
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Indica que la página de mensajes DLQ fue devuelta exitosamente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLQListResponse'
              examples:
                page:
                  summary: Un mensaje DLQ devuelto
                  value:
                    messages:
                      - messageId: 019c96a0-d1d2-7e3f-4a5b-6c7d8e9f0a1b
                        routingKey: webhook.transfer.completed
                        deathReason: rejected
                        failureReason: HTTP 500 from subscriber
                        tenantId: 11111111-1111-1111-1111-111111111111
                        transferId: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d
                        eventType: transfer.completed
                        correlationId: 019c96a0-cc10-7abc-d1e2-3f4a5b6c7d8e
                        retryCount: 5
                        manualRetryCount: 1
                        timestamp: '2026-02-01T15:35:00-03:00'
                    totalCount: 1
                    returnedCount: 1
                    returned: 1
                    hasNextPage: false
                    hasMore: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    DLQListResponse:
      type: object
      required:
        - messages
        - totalCount
        - returnedCount
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/DLQMessage'
        totalCount:
          type: integer
          minimum: 0
          description: >-
            Cantidad de mensajes filtrados por tenant visitados durante este
            escaneo. Cuando `hasMore` es true, este es un límite inferior
            best-effort sobre la profundidad real de la DLQ para este tenant, no
            el conteo total.
          example: 1
        returnedCount:
          type: integer
          minimum: 0
          description: Número de mensajes en esta página después de aplicar offset y limit.
          example: 1
        returned:
          type: integer
          minimum: 0
          description: Número de mensajes devueltos en esta página.
          example: 1
        hasNextPage:
          type: boolean
          description: >-
            Indica si hay más mensajes visibles para el tenant más allá de esta
            página.
          example: false
        hasMore:
          type: boolean
          description: >-
            True cuando el inspector detuvo el escaneo temprano después de
            llenar la página actual.
          example: false
        warning:
          type: string
          description: >-
            Definido cuando la paginación puede ser no determinística (p. ej.,
            el acceso concurrente desplaza el ordenamiento).
          example: pagination may be non-deterministic under concurrent access
    DLQMessage:
      type: object
      required:
        - messageId
        - routingKey
        - deathReason
        - failureReason
        - tenantId
        - eventType
        - retryCount
        - manualRetryCount
        - timestamp
      properties:
        messageId:
          type: string
          description: Identificador único del mensaje DLQ.
          example: 019c96a0-d1d2-7e3f-4a5b-6c7d8e9f0a1b
        routingKey:
          type: string
          description: Routing key original con la cual se publicó el mensaje.
          example: webhook.transfer.completed
        deathReason:
          type: string
          description: >-
            Razón por la que el broker dead-letter el mensaje (p. ej.,
            `rejected`, `expired`, `maxlen`).
          example: rejected
        failureReason:
          type: string
          description: >-
            Detalle del último fallo del lado del subscriber capturado antes de
            que el mensaje fuera dead-letter.
          example: HTTP 500 from subscriber
        tenantId:
          type: string
          format: uuid
          description: Tenant propietario del mensaje.
          example: 11111111-1111-1111-1111-111111111111
        transferId:
          type: string
          format: uuid
          description: >-
            ID de transferencia asociado con el evento de webhook, cuando está
            presente.
          example: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d
        eventType:
          type: string
          description: >-
            Tipo de evento de webhook (p. ej., `transfer.completed`,
            `transfer.rejected`).
          example: transfer.completed
        correlationId:
          type: string
          description: >-
            ID de correlación propagado desde la solicitud originaria, cuando
            está presente.
          example: 019c96a0-cc10-7abc-d1e2-3f4a5b6c7d8e
        retryCount:
          type: integer
          minimum: 0
          description: Número de intentos automáticos de entrega antes del dead-lettering.
          example: 5
        manualRetryCount:
          type: integer
          minimum: 0
          description: Número de reintentos manuales ya disparados para este mensaje.
          example: 1
        timestamp:
          type: string
          format: date-time
          description: Momento en que el mensaje fue dead-letter.
          example: '2026-02-01T15:35:00-03:00'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - service
            - category
            - message
            - requestId
          properties:
            code:
              type: string
              description: >-
                El código de error estable. Los errores del plugin usan el
                formato `BTF-XXXX`; los rechazos de negocio/autenticación de JD
                SPB transmiten el código del proveedor sin modificar (p. ej.
                `AAC90`, `ACE95`, `DVE01`), y los fallos de JD a nivel de
                transporte muestran los marcadores sintéticos `TRANSPORT` o
                `JD_MISSING_CODE`. Haga la coincidencia sobre este valor en
                lugar del estado HTTP.
              example: BTF-0010
            service:
              type: string
              description: El servicio o dominio que produjo el error.
              example: plugin
            category:
              type: string
              description: >-
                Categoría de error legible por máquina utilizada para las
                decisiones de reintento.
              enum:
                - deterministic
                - transient
                - rate_limit
                - plugin
              example: deterministic
            message:
              type: string
              description: Un resumen del error legible por humanos.
              example: >-
                Transfers can only be initiated Monday-Friday between 06:30 and
                17:00 Brasília time
            requestId:
              type: string
              description: >-
                El ID de correlación de la solicitud. Presente incluso cuando
                está vacío.
              example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            fields:
              type: object
              additionalProperties: true
              description: >-
                Metadatos estructurados de validación o reintento cuando están
                disponibles. Los detalles de validación a nivel de campo,
                encabezado, ruta y consulta se devuelven todos aquí.
              example:
                currentTime: '2026-02-01T18:30:00-03:00'
                operatingHours: Mon-Fri 06:30-17:00 UTC-3
  responses:
    BadRequest:
      description: >-
        Indica que la solicitud contiene datos de entrada inválidos. Verifique
        los detalles del campo para errores de validación específicos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidInput:
              summary: Validation error
              value:
                error:
                  code: BTF-0001
                  service: plugin
                  category: deterministic
                  message: >-
                    The request contains invalid fields. Check the field details
                    below.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                  fields:
                    recipientIspb: must be 8 digits
                    amount: must be positive
    Unauthorized:
      description: Indica que la solicitud no tiene un token de autenticación válido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              summary: Missing authorization
              value:
                error:
                  code: BTF-0401
                  service: plugin
                  category: deterministic
                  message: Missing or invalid authentication token
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    Forbidden:
      description: >-
        Indica que el llamador está autenticado pero carece de permiso para esta
        operación, o el tenant no está licenciado para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notLicensed:
              summary: Tenant not licensed
              value:
                error:
                  code: BTF-0403
                  service: plugin
                  category: deterministic
                  message: Tenant is not licensed to use this endpoint
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            permissionDenied:
              summary: Caller lacks permission
              value:
                error:
                  code: BTF-0405
                  service: plugin
                  category: deterministic
                  message: Caller lacks permission for this resource
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    InternalServerError:
      description: Indica que ocurrió un error interno inesperado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Internal error
              value:
                error:
                  code: BTF-9000
                  service: plugin
                  category: plugin
                  message: Unexpected error while processing the request
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    ServiceUnavailable:
      description: >-
        Indica que un servicio externo (CRM, JD SPB, Midaz o Fees) no está
        disponible temporalmente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            crmUnavailable:
              summary: CRM service down
              value:
                error:
                  code: BTF-0502
                  service: crm
                  category: transient
                  message: >-
                    Unable to validate account. The CRM service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            jdUnavailable:
              summary: JD SPB unavailable
              value:
                error:
                  code: TRANSPORT
                  service: jd_spb
                  category: transient
                  message: >-
                    Unable to submit transfer. The JD SPB service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            midazUnavailable:
              summary: Midaz ledger unavailable
              value:
                error:
                  code: BTF-2000
                  service: midaz
                  category: transient
                  message: >-
                    Unable to process transfer. The Midaz ledger service is
                    temporarily unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            feeServiceUnavailable:
              summary: Fee service unavailable (fail-closed mode)
              value:
                error:
                  code: BTF-3000
                  service: fees
                  category: transient
                  message: >-
                    Unable to calculate fee. The fee service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            dlqInspectorUnavailable:
              summary: DLQ inspector not configured
              value:
                error:
                  code: BTF-9005
                  service: plugin
                  category: deterministic
                  message: DLQ inspector is not configured
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Autenticación mediante token JWT Bearer. El tenantId se deriva del token
        bearer o del contexto autenticado de la solicitud y no se proporciona a
        través de X-Organization-Id.

````