Webhooks

Esta seção reúne endpoints para gerenciamento de notificações por parte do PSP recebedor a pessoa usuária recebedora.

Configurar webhook

Endpoint para criar uma nova configuração de webhook para receber notificações automáticas dos eventos do DICT.

POST /v1/webhook

Requer autorização para o escopo: webhook.write

Requisição

Exemplo

{
  "webhookUrl": "https://api.exemplo.com/webhook/dict",
  "contexts": [
    "dict-claim",
    "dict-refund-request"
  ]
}

Respostas

As respostas abaixo representam Sucesso(201) e Falhas/erros do consumo.

🟢 201

{
  "uuid": "dd320762-cbf1-465a-b7d8-2fddf51325ac"
}

🔴 401

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "invalid or inactive credentials",
    "status": 401,
    "title": "invalid_client"
  }
}

🔴 403

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not allowed to access this resource",
    "status": 403,
    "title": "Forbidden"
  }
}

🔴 500

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  }
}

🔴 503

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  }
}

Listar webhooks

Endpoint para listar todos os webhooks configurados para sua conta.

GET /v1/webhook

Requer autorização para o escopo: webhook.read

Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth e o certificado da conta.

Respostas

A resposta abaixo representa Sucesso(200) do consumo.

🟢 200

{
  "webhooks": [
    {
      "id": "dd320762-cbf1-465a-b7d8-2fddf51325ac",
      "webhookUrl": "https://api.exemplo.com/webhook/dict",
      "cnpj": "12345678000195",
      "criacao": "2024-01-15T10:30:00Z",
      "contexts": [
        "dict-claim",
        "dict-refund-request"
      ]
    }
  ]
}

Consultar webhook

Endpoint para consultar detalhes específicos de um webhook.

GET /v1/webhook/:uuid

Requer autorização para o escopo: webhook.read

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
  "id": "dd320762-cbf1-465a-b7d8-2fddf51325ac",
  "webhookUrl": "https://api.exemplo.com/webhook/dict",
  "contexts": [
    "dict-claim",
    "dict-refund-request"
  ],
  "criacao": "2024-01-15T10:30:00Z"
}

🔴 401

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "invalid or inactive credentials",
    "status": 401,
    "title": "invalid_client"
  }
}

🔴 403

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not allowed to access this resource",
    "status": 403,
    "title": "Forbidden"
  }
}

🔴 500

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  }
}

🔴 503

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  }
}

Atualizar contextos do webhook

Endpoint para atualizar os contextos de um webhook existente.

PUT /v1/webhook/:uuid

Requer autorização para o escopo: webhook.write

Requisição

Exemplo

{
  "contexts": [
    "dict-claim",
    "dict-refund-request"
  ]
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
  "id": "dd320762-cbf1-465a-b7d8-2fddf51325ac",
  "webhookUrl": "https://api.exemplo.com/webhook/dict",
  "criacao": "2024-01-15T10:30:00Z",
  "contexts": [
    "dict-claim",
    "dict-refund-request"
  ]
}

🔴 401

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "invalid or inactive credentials",
    "status": 401,
    "title": "invalid_client"
  }
}

🔴 403

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not allowed to access this resource",
    "status": 403,
    "title": "Forbidden"
  }
}

🔴 500

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  }
}

🔴 503

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  }
}

Deletar webhook

Endpoint para remover permanentemente um webhook configurado.

DELETE /v1/webhook/:uuid

Requer autorização para o escopo: webhook.write

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
  "id": "dd320762-cbf1-465a-b7d8-2fddf51325ac",
  "webhookUrl": "https://api.exemplo.com/webhook/dict",
  "criacao": "2024-01-15T10:30:00Z",
  "contexts": [
    "dict-claim",
    "dict-refund-request"
  ]
}

🔴 401

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "invalid or inactive credentials",
    "status": 401,
    "title": "invalid_client"
  }
}

🔴 403

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not allowed to access this resource",
    "status": 403,
    "title": "Forbidden"
  }
}

🔴 500

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  }
}

🔴 503

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  }
}