Documentação do Webhook de Infração

Visão Geral

Nosso sistema de webhook envia notificações em tempo real sobre infrações detectadas em transações. Quando uma infração é identificada, uma requisição POST é enviada para a URL configurada com informações detalhadas da ocorrência.

Payload do Webhook

O webhook envia um payload JSON contendo os detalhes da infração e da transação relacionada.

Exemplo de Payload

{
  "transactionId": "5a94d48d-c9f3-46be-8448-83510ca42bde",
  "transactionStatus": "MED",
  "transactionType": "CASH_IN",
  "value": 18,
  "externalId": "T&ste378",
  "e2e_id": "E082535392025011818245238600338f"
}

Descrição dos Campos

Informações da Transação

  • transactionId (string): Identificador único da transação no formato UUID
  • transactionStatus (string): Status atual da transação. Valores possíveis:
    • MED: Transação solicitada MED
  • transactionType (string): Tipo da transação, neste caso “CASH_IN”
  • value (string): Valor da transação
  • externalId (string): ID de referência externa fornecido pelo cliente

Boas Práticas

1

Confirme o recebimento do webhook com uma resposta 200 OK
2

Implemente verificações de idempotência usando o transactionId e externalId
3

Processe webhooks de forma assíncrona
4

Mantenha logs dos webhooks recebidos para resolução de problemas
5

Implemente lógica de retry para entregas de webhook falhas

O Webhook deve retornar Status Code 200

Para que a transação tenha seu fluxo finalizado com Sucesso é de extrema importancia que seja retornado 200 na resposta!