Skip to main content

Webhook

Webhooks are automatic notifications the API sends whenever an event related to a MED happens. That way you do not have to keep polling the API: you just receive and process the event when it arrives.

Webhook events​

Each webhook represents a change in the life cycle of the MED.

Event types​

EventDescription
MED_CREATEDMED created
MED_CLOSEDMED closed
MED_APPEALEDMED defense submitted
MED_APPROVEDMED approved
MED_REJECTEDMED rejected

Webhook data​

FieldTypeRequiredDescription
typestring (enum) - MED_CREATED, MED_CLOSED, MED_APPEALED, MED_APPROVED, MED_REJECTEDYesEvent type
dataobjectYesMED data (see Sub-Objects data)

Sub-Objects​

data​

FieldTypeRequiredDescription
idstring (UUID)YesUnique identifier of the transaction
amountnumberYesTransaction amount (integer, in cents)
externalCodestringNoYour reference code
createdAtstring (ISO)YesCreation date
statusstring (enum) - BLOCKED, PAID, PROCESSING_INFRACTION, INFRACTIONYes
  • BLOCKED: transaction blocked by a MED
  • PAID: transaction released
  • PROCESSING_INFRACTION: infraction being processed
  • INFRACTION: infraction confirmed
endToEndstringNoEnd-to-end identifier of the transaction
medobjectYesMED data (see Sub-Object Med)

Med​

FieldTypeRequiredDescription
idstring (UUID)YesUnique identifier of the MED
createdAtstring (ISO)YesCreation date
statusstring (enum) - PENDING, APPEALED, APPROVED, REJECTEDYesMED status

Payload example​

{
"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"
}
}
}