Adyen · Schema

ReportAvailableNotificationRequestItem

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
additionalData	object	A generic container for extra fields.
amount	object	The payment amount. For HTTP POST notifications, currency and value are returned as URL parameters.
eventCode	string	The type of event the notification item is for.
eventDate	string	The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD
merchantAccountCode	string	The merchant account identifier used in the transaction the notification item is for.
merchantReference	string	Your reference to uniquely identify the payment.
originalReference	string	For modifications, this field corresponds to the payment request assigned to the original payment.
paymentMethod	string	The payment method used in the transaction.
pspReference	string	Contains the file name of the report.
reason	string	Contains the download URL where you can obtain a copy of the report.
success	string	Always `true`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReportAvailableNotificationRequestItem",
  "title": "ReportAvailableNotificationRequestItem",
  "properties": {
    "additionalData": {
      "description": "A generic container for extra fields.",
      "$ref": "#/components/schemas/NotificationAdditionalData"
    },
    "amount": {
      "description": "The payment amount. For HTTP POST notifications, currency and value are returned as URL parameters.",
      "$ref": "#/components/schemas/Amount"
    },
    "eventCode": {
      "description": "The type of event the notification item is for.",
      "enum": [
        "REPORT_AVAILABLE"
      ],
      "type": "string"
    },
    "eventDate": {
      "description": "The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD",
      "example": "2021-07-17T13:42:40+01:00",
      "format": "date-time",
      "type": "string"
    },
    "merchantAccountCode": {
      "description": "The merchant account identifier used in the transaction the notification item is for.",
      "type": "string"
    },
    "merchantReference": {
      "description": "Your reference to uniquely identify the payment.",
      "type": "string"
    },
    "originalReference": {
      "description": "For modifications, this field corresponds to the payment request assigned to the original payment.",
      "type": "string"
    },
    "paymentMethod": {
      "description": "The payment method used in the transaction.",
      "example": "visa, mc, iDeal",
      "type": "string"
    },
    "pspReference": {
      "description": "Contains the file name of the report.",
      "type": "string"
    },
    "reason": {
      "description": "Contains the download URL where you can obtain a copy of the report.",
      "type": "string"
    },
    "success": {
      "description": "Always `true`.",
      "type": "string"
    }
  },
  "required": [
    "merchantReference",
    "merchantAccountCode",
    "eventDate",
    "amount",
    "eventCode",
    "reason",
    "success",
    "pspReference"
  ],
  "type": "object"
}