> ## 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 Mensagens da DLQ > Use este endpoint para listar mensagens atualmente na dead-letter queue de webhooks, com escopo no tenant do chamador. O tenant é derivado do JWT bearer (claim `tenantId`), nunca de um cabeçalho de requisição. Esta rota só é montada quando a autenticação está habilitada e um inspector de DLQ está configurado. Caso contrário, não é exposta e qualquer requisição é rejeitada com 503. ## OpenAPI ````yaml pt/openapi/v3-current/ted.yaml get /v1/webhooks/dlq openapi: 3.0.3 info: title: API do Plugin de Transferência Bancária (TED) description: >- API completa para transferências bancárias brasileiras (TED OUT, TED IN, P2P) através da plataforma Lerian, incluindo iniciação de transferências, processamento, acompanhamento de status e cancelamento. version: 1.1.9 servers: - url: https://plugin-br-bank-transfer.sandbox.lerian.net description: Sandbox (placeholder — ainda não disponível para acesso público) security: - BearerAuth: [] tags: - name: Transfers API description: Endpoints para iniciar, processar, acompanhar e cancelar transferências. - name: Webhooks description: >- Endpoints para registrar e gerenciar assinaturas de webhook com escopo de tenant para eventos de transferência. - name: Webhook DLQ description: >- Endpoints para inspecionar e reprocessar mensagens da dead-letter queue de webhooks. paths: /v1/webhooks/dlq: get: tags: - Webhook DLQ summary: Listar Mensagens da DLQ description: >- Use este endpoint para listar mensagens atualmente na dead-letter queue de webhooks, com escopo no tenant do chamador. O tenant é derivado do JWT bearer (claim `tenantId`), nunca de um cabeçalho de requisição. Esta rota só é montada quando a autenticação está habilitada e um inspector de DLQ está configurado. Caso contrário, não é exposta e qualquer requisição é rejeitada com 503. operationId: listDLQMessages parameters: - name: limit in: query required: false description: Número máximo de mensagens a retornar. schema: type: integer minimum: 1 maximum: 200 default: 50 - name: offset in: query required: false description: Número de mensagens a pular para paginação. schema: type: integer minimum: 0 default: 0 responses: '200': description: Indica que a página de mensagens da DLQ foi retornada com sucesso. content: application/json: schema: $ref: '#/components/schemas/DLQListResponse' examples: page: summary: Uma mensagem da DLQ retornada 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: >- Quantidade de mensagens filtradas por tenant visitadas durante este scan. Quando `hasMore` é true, este é um limite inferior best-effort sobre a profundidade real da DLQ para este tenant, não o total real. example: 1 returnedCount: type: integer minimum: 0 description: Número de mensagens nesta página após aplicar offset e limit. example: 1 returned: type: integer minimum: 0 description: Número de mensagens retornadas nesta página. example: 1 hasNextPage: type: boolean description: Se há mais mensagens visíveis ao tenant além desta página. example: false hasMore: type: boolean description: >- True quando o inspector parou o scan cedo após preencher a página atual. example: false warning: type: string description: >- Definido quando a paginação pode ser não-determinística (por exemplo, acesso concorrente desloca a ordenação). 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 da mensagem da DLQ. example: 019c96a0-d1d2-7e3f-4a5b-6c7d8e9f0a1b routingKey: type: string description: Routing key original com a qual a mensagem foi publicada. example: webhook.transfer.completed deathReason: type: string description: >- Razão pela qual o broker dead-letter a mensagem (por exemplo, `rejected`, `expired`, `maxlen`). example: rejected failureReason: type: string description: >- Detalhe da última falha do lado do subscriber capturada antes de a mensagem ser dead-letter. example: HTTP 500 from subscriber tenantId: type: string format: uuid description: Tenant proprietário da mensagem. example: 11111111-1111-1111-1111-111111111111 transferId: type: string format: uuid description: ID de transferência associado ao evento de webhook, quando presente. example: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d eventType: type: string description: >- Tipo de evento de webhook (por exemplo, `transfer.completed`, `transfer.rejected`). example: transfer.completed correlationId: type: string description: >- ID de correlação propagado a partir da requisição originária, quando presente. example: 019c96a0-cc10-7abc-d1e2-3f4a5b6c7d8e retryCount: type: integer minimum: 0 description: Número de tentativas automáticas de entrega antes do dead-lettering. example: 5 manualRetryCount: type: integer minimum: 0 description: Número de retries manuais já disparados para esta mensagem. example: 1 timestamp: type: string format: date-time description: Momento em que a mensagem foi 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: >- O código de erro estável. Erros do plugin usam o formato `BTF-XXXX`; rejeições de negócio/autenticação do JD SPB repassam o código bruto do fornecedor literalmente (por exemplo, `AAC90`, `ACE95`, `DVE01`), e falhas de transporte no nível do JD expõem os marcadores sintéticos `TRANSPORT` ou `JD_MISSING_CODE`. Faça a correspondência com base neste valor, e não no status HTTP. example: BTF-0010 service: type: string description: O serviço ou domínio que produziu o erro. example: plugin category: type: string description: >- Categoria de erro legível por máquina usada para decisões de reprocessamento. enum: - deterministic - transient - rate_limit - plugin example: deterministic message: type: string description: Um resumo do erro legível por humanos. example: >- Transferências só podem ser iniciadas de segunda a sexta entre 06:30 e 17:00 horário de Brasília requestId: type: string description: O ID de correlação da requisição. Presente mesmo quando vazio. example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: type: object additionalProperties: true description: >- Metadados estruturados de validação ou reprocessamento quando disponíveis. Detalhes de validação em nível de campo, cabeçalho, caminho e consulta são todos retornados aqui. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 responses: BadRequest: description: >- Indica que a requisição contém entrada inválida. Verifique os detalhes do campo para erros de validação 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 a requisição não possui um token de autenticação 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 o chamador está autenticado mas não tem permissão para esta operação, ou o tenant não 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 ocorreu um erro 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 um serviço externo (CRM, JD SPB, Midaz ou Fees) está temporariamente indisponível. 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: >- Autenticação por token JWT Bearer. O tenantId é derivado do token bearer ou do contexto de requisição autenticado e não é fornecido por meio do X-Organization-Id. ````