Adyen · JSON Structure

Management Custom Notification Structure

CustomNotification schema from Adyen API

Type: object Properties: 7
PaymentsFinancial ServicesFintech

CustomNotification is a JSON Structure definition published by Adyen, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

amount eventCode eventDate merchantReference paymentMethod reason success

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-custom-notification-structure.json",
  "description": "CustomNotification schema from Adyen API",
  "type": "object",
  "properties": {
    "amount": {
      "description": "The amount of the payment that the notification is about. Set the value in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
      "$ref": "#/components/schemas/Amount"
    },
    "eventCode": {
      "description": "The event that caused the notification to be sent.Currently supported values:\n* **AUTHORISATION**\n* **CANCELLATION**\n* **REFUND**\n* **CAPTURE**\n* **REPORT_AVAILABLE**\n* **CHARGEBACK**\n* **REQUEST_FOR_INFORMATION**\n* **NOTIFICATION_OF_CHARGEBACK**\n* **NOTIFICATIONTEST**\n* **ORDER_OPENED**\n* **ORDER_CLOSED**\n* **CHARGEBACK_REVERSED**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**",
      "type": "string"
    },
    "eventDate": {
      "description": "The time of the event. Format: [ISO 8601](http://www.w3.org/TR/NOTE-datetime), YYYY-MM-DDThh:mm:ssTZD.",
      "type": "datetime"
    },
    "merchantReference": {
      "description": "Your reference for the custom test notification.",
      "type": "string"
    },
    "paymentMethod": {
      "description": "The payment method for the payment that the notification is about. Possible values:\n* **amex**\n* **visa**\n* **mc**\n* **maestro**\n* **bcmc**\n* **paypal**\n * **sms**\n * **bankTransfer_NL**\n* **bankTransfer_DE**\n* **bankTransfer_BE**\n* **ideal**\n* **elv**\n* **sepadirectdebit**\n",
      "type": "string"
    },
    "reason": {
      "description": "A descripton of what caused the notification.",
      "type": "string"
    },
    "success": {
      "description": "The outcome of the event which the notification is about. Set to either **true** or **false**. ",
      "type": "boolean"
    }
  },
  "name": "CustomNotification"
}