Adyen · Schema

CustomNotification

PaymentsFinancial ServicesFintech

Properties

Name Type Description
amount object The amount of the payment that the notification is about. Set the value in [minor units](https://docs.adyen.com/development-resources/currency-codes).
eventCode string The event that caused the notification to be sent.Currently supported values: * **AUTHORISATION** * **CANCELLATION** * **REFUND** * **CAPTURE** * **REPORT_AVAILABLE** * **CHARGEBACK** * **REQUEST_FOR_
eventDate string The time of the event. Format: [ISO 8601](http://www.w3.org/TR/NOTE-datetime), YYYY-MM-DDThh:mm:ssTZD.
merchantReference string Your reference for the custom test notification.
paymentMethod string The payment method for the payment that the notification is about. Possible values: * **amex** * **visa** * **mc** * **maestro** * **bcmc** * **paypal** * **sms** * **bankTransfer_NL** * **bankTransfe
reason string A descripton of what caused the notification.
success boolean The outcome of the event which the notification is about. Set to either **true** or **false**.
View JSON Schema on GitHub

JSON Schema

adyen-customnotification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomNotification",
  "title": "CustomNotification",
  "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.",
      "format": "date-time",
      "type": "string"
    },
    "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"
    }
  },
  "type": "object"
}