Adyen · JSON Structure

Webhooks Recurring Contract Notification Request Item Structure

RecurringContractNotificationRequestItem schema from Adyen API

Type: object Properties: 12 Required: 8
PaymentsFinancial ServicesFintech

RecurringContractNotificationRequestItem is a JSON Structure definition published by Adyen, describing 12 properties, of which 8 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

additionalData amount eventCode eventDate merchantAccountCode merchantReference originalPsp originalReference paymentMethod pspReference 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/webhooks-recurring-contract-notification-request-item-structure.json",
  "description": "RecurringContractNotificationRequestItem schema from Adyen API",
  "type": "object",
  "properties": {
    "additionalData": {
      "description": "This object is a generic container that can hold extra fields.",
      "$ref": "#/components/schemas/RecurringContractNotificationAdditionalData"
    },
    "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": [
        "RECURRING_CONTRACT"
      ],
      "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",
      "type": "datetime"
    },
    "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"
    },
    "originalPsp": {
      "description": "The `pspReference` of the initial 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": "The [token for stored payment details](https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens/) to make recurring payments. This is the same as the `recurringDetailReference`.",
      "type": "string"
    },
    "reason": {
      "description": "If `success` = `false`, then this includes a short message with an explanation for the refusal.",
      "type": "string"
    },
    "success": {
      "description": "Informs about the outcome of the event (`eventCode`) the notification is for. \nIf `true`: the event was executed successfully. \nIf `false`: the event was not executed successfully.",
      "type": "string"
    }
  },
  "required": [
    "merchantReference",
    "merchantAccountCode",
    "eventDate",
    "amount",
    "success",
    "eventCode",
    "originalPsp",
    "pspReference"
  ],
  "name": "RecurringContractNotificationRequestItem"
}