Webhook

Webhooks são notificações automáticas que a API envia sempre que ocorre um evento relacionado a um MED. Assim, você não precisa ficar consultando a API: basta receber e processar o evento quando ele chegar.

Eventos de webhook

Cada webhook representa uma mudança no ciclo de vida do MED.

Tipos de evento

Evento	Descrição
MED_CREATED	MED criado
MED_CLOSED	MED encerrado
MED_APPEALED	Defesa do MED apresentada
MED_APPROVED	MED aprovado
MED_REJECTED	MED rejeitado

Dados do webhook

Campo	Tipo	Obrigatório	Descrição
type	string (enum) - MED_CREATED, MED_CLOSED, MED_APPEALED, MED_APPROVED, MED_REJECTED	Sim	Tipo do evento
data	object	Sim	Dados do MED (ver Sub-Objetos data)

Sub-Objetos

data

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador único da transação
amount	number	Sim	Valor da transação (inteiro em centavos)
externalCode	string	Não	Seu código de referência
createdAt	string (ISO)	Sim	Data de criação
status	string (enum) - BLOCKED, PAID, PROCESSING_INFRACTION, INFRACTION	Sim	BLOCKED: Transação bloqueada por MED PAID: Transação liberada PROCESSING_INFRACTION: Infração em processamento INFRACTION: Infração confirmada
endToEnd	string	Não	Identificador end-to-end da transação
med	object	Sim	Dados do MED (ver Sub-Objeto Med)

Med

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador único do MED
createdAt	string (ISO)	Sim	Data de criação
status	string (enum) - PENDING, APPEAL, APPROVED, REJECTED	Sim	Status do MED

Exemplo de payload

{
  "type": "MED_CREATED",
  "data": {
    "id": "553e8400-e29b-41d4-a716-436251480000",
    "amount": 10000,
    "externalCode": "TRANS-123",
    "createdAt": "2026-03-06T12:49:04.681Z",
    "status": "BLOCKED",
    "endToEnd": "E2E123456789",
    "med": {
      "id": "993e8400-e29b-41d4-a716-436251480001",
      "createdAt": "2026-03-06T12:49:04.681Z",
      "status": "PENDING"
    }
  }
}