Histórico de webhooks de uma cobrança

GET

/api/charges/detail/{{correlationID}}/webhooks

Autenticação

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:

Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Lista todas as tentativas de envio de webhook desta cobrança específica, com status (ENVIADO/FALHA), código HTTP, tentativas e duração. Útil para auditoria de integração. Escopo: charges:read.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '/api/charges/detail/{{correlationID}}/webhooks' \
--header 'Authorization: Bearer <token>'

Response Example

[
  {
    "id": "clwhfwd0001",
    "event": "CHARGE_COMPLETED",
    "endpointName": "Backend produção",
    "endpointUrl": "https://api.suaempresa.com.br/webhooks/dotfy",
    "status": "SUCCESS",
    "payload": {
      "event": "EVENT:CHARGE_PAID",
      "data": {
        "id": "clcharge0001",
        "status": "PAID",
        "amount": 2990
      }
    },
    "responseStatus": 200,
    "responseBody": "{\"received\":true}",
    "responseTime": 245,
    "createdAt": "2026-05-07T14:35:12.000Z",
    "sentAt": "2026-05-07T14:35:12.500Z",
    "error": null,
    "retryCount": 0,
    "hasForward": true
  }
]

Modificado em 2026-07-02 06:57:27

Página anterior

Consultar cobrança por correlationID

Próxima página

Cartão (Checkout Transparente)

Histórico de webhooks de uma cobrança

Autenticação#

Requisição

Respostas

Autenticação