Notifications Schema Reference

Shared Parameters

Field	Location	Required	Type	Format / Constraints
X-API-KEY	Header	Yes	string	Not specified in schema
mpid	Path	Yes	string	Supplier MPID

GET Query Parameters

Field	Required	Type	Format / Constraints	Notes
received_on	No	string	ISO 8601 datetime	Must be a valid ISO 8601 timestamp.
completed	No	boolean	true or false	Defaults to false.
mpan_id	No	integer	13 digits in practice	Optional MPAN filter.

Notification Response Schema (NotificationResponse)

Field	Required	Type	Format / Constraints	Notes
id	Yes	string	UUID	Notification identifier.
mpan_core	No	integer or null	13 digits in practice	MPAN linked to the notification, when present.
received_on	Yes	string(datetime)	ISO 8601 datetime	Notification receive timestamp.
notification_type	Yes	string	Not specified	Notification classification.
detail	Yes	object	Free-form JSON object	Payload structure depends on notification_type.
completed	Yes	boolean	N/A	Completion flag.
completed_on	No	string(datetime) or null	ISO 8601 datetime	Populated after response/completion.

Detail Payload Notes

detail is an open JSON object. A rejected consumption notification can include fields such as:

• issuing_data_service_dip_id: string.
• connection_type: string.
• connection_type_efd: string.
• mqid: string.
• settlement_days: optional array of settlement day objects with nested rejected consumption periods.