Adyen · Schema

EventNotification

It conveys Information related to the event, and possible action (maintenance, message to display). Content of the EventNotification message.

PaymentsFinancial ServicesFintech

Properties

Name Type Description
TimeStamp string Date and time of a transaction for the Sale System, the POI System or the Acquirer.
EventToNotify object
EventDetails string If present, the Sale logs it for further examination.
RejectedMessage string Mandatory if EventToNotify is Reject, absent in other cases.
MaintenanceRequiredFlag boolean Indicates if the occurred event requires maintenance call or action.
CustomerLanguage string If the language is selected by the Sale System before the request to the POI.
DisplayOutput array
View JSON Schema on GitHub

JSON Schema

adyen-eventnotification-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventNotification",
  "title": "EventNotification",
  "type": "object",
  "description": "It conveys Information related to the event, and possible action (maintenance, message to display). Content of the EventNotification message.",
  "properties": {
    "TimeStamp": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of a transaction for the Sale System, the POI System or the Acquirer."
    },
    "EventToNotify": {
      "$ref": "#/components/schemas/EventToNotify"
    },
    "EventDetails": {
      "type": "string",
      "pattern": "^.+$",
      "description": "If present, the Sale logs it for further examination."
    },
    "RejectedMessage": {
      "type": "string",
      "format": "byte",
      "pattern": "^.+$",
      "description": "Mandatory if EventToNotify is Reject, absent in other cases."
    },
    "MaintenanceRequiredFlag": {
      "type": "boolean",
      "default": false,
      "description": "Indicates if the occurred event requires maintenance call or action."
    },
    "CustomerLanguage": {
      "type": "string",
      "pattern": "^[a-z]{2,2}$",
      "description": "If the language is selected by the Sale System before the request to the POI."
    },
    "DisplayOutput": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DisplayOutput"
      }
    }
  },
  "required": [
    "TimeStamp",
    "EventToNotify"
  ]
}