Adyen · Schema

AuthorisationNotificationRequestItem

AuthorisationNotificationRequestItem schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
additionalData	object	This object is a generic container that can hold 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.
operations	array	The operations indicate the supported follow-up actions concerning the payment. > This is an experimental field. Do not base your code on this field. Not all specific cases are covered yet. It's p
paymentMethod	string	The payment method used in the transaction.
pspReference	string	Adyen's 16-character unique reference associated with the transaction or request. This value is globally unique. Use it when communicating with us about this request.
reason	string	If `success` = `true` and `paymentMethod` = `visa`, `mc`, or `amex` then this field contains the following details: Authorisation code, last 4 digits of the card, card expiry date. In case of failure,
success	string	If `true`: The payment request was successful. If `false`: The payment request failed. Check the `reason` field for failure information.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/webhooks-authorisation-notification-request-item-schema.json",
  "title": "AuthorisationNotificationRequestItem",
  "description": "AuthorisationNotificationRequestItem schema from Adyen API",
  "type": "object",
  "properties": {
    "additionalData": {
      "description": "This object is a generic container that can hold extra fields.",
      "$ref": "#/components/schemas/AuthorisationNotificationAdditionalData"
    },
    "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": [
        "AUTHORISATION"
      ],
      "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"
    },
    "operations": {
      "description": "The operations indicate the supported follow-up actions concerning the payment.\n> This is an **experimental field**. Do not base your code on this field. Not all specific cases are covered yet. It's possible that the field is empty or contains generic information.",
      "items": {
        "enum": [
          "CAPTURE",
          "CANCEL",
          "REFUND"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "paymentMethod": {
      "description": "The payment method used in the transaction.",
      "example": "visa, mc, iDeal",
      "type": "string"
    },
    "pspReference": {
      "description": "Adyen's 16-character unique reference associated with the transaction or request. This value is globally unique. Use it when communicating with us about this request.",
      "type": "string"
    },
    "reason": {
      "description": "If `success` = `true` and `paymentMethod` = `visa`, `mc`, or `amex` then this field contains the following details: \nAuthorisation code, last 4 digits of the card, card expiry date. \n In case of failure, this contains information about the authorisation failure",
      "example": "874574:1935:11/2012",
      "type": "string"
    },
    "success": {
      "description": "If `true`: The payment request was successful. \n If `false`: The payment request failed. \n Check the `reason` field for failure information.",
      "type": "string"
    }
  },
  "required": [
    "pspReference",
    "merchantReference",
    "merchantAccountCode",
    "eventDate",
    "amount",
    "eventCode",
    "success"
  ]
}