Understand notifications

Each notification contains an eventCode that specifies which type of event triggered the notification. Some eventCodes are enabled in Standard notifications by default, and some need to be enabled.

In addition to Standard notifications, you can set up endpoints to receive specific types of notifications.

Notification structure

Each notification contains the following fields:

• live: Specifies whether the event that triggered the notification happened on the test or live environment.
• notificationsItems: An array of NotificationRequestItem objects.

  JSON and HTTP POST notifications always contain a single NotificationRequestItem object. SOAP notifications may contain up to six NotificationRequestItem objects, in case the events triggering notifications happen within a very short period of time.

The notificationsItems object contains information about the event that triggered the notification:

• additionalData: Additional information about the shopper or the transaction. For more information about the fields that you can receive in additionalData, refer to Additional settings.
• eventCode: The type of event that triggered the notification. For a list of possible eventCode values, refer to Event codes.
• success: The outcome of the event, set to either true or false.

  For some event codes, such as REPORT_AVAILABLE, the success field is always set to true.

• eventDate: The time of the event. Format: ISO 8601; YYYY-MM-DDThh:mm:ssTZD

{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "additionalData": {
                ...
            },
            "eventCode":"AUTHORISATION",
            "success":"true",
            "eventDate":"2019-06-28T18:03:50+01:00",
            "merchantAccountCode":"YOUR_MERCHANT_ACCOUNT",
            "pspReference": "7914073381342284",
            "merchantReference": "YOUR_REFERENCE",
            "amount": {
                "value":1130,
                "currency":"EUR"
            }
         }
      }
   ]
}

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:sendNotification xmlns:ns1="http://notification.services.adyen.com">
      <ns1:Notification>
        <live xmlns="http://notification.services.adyen.com">false</live>
        <notificationItems xmlns="http://notification.services.adyen.com">
          <NotificationRequestItem>
            <additionalData>
              ...
            </additionalData>
            <amount>
              <currency xmlns="http://common.services.adyen.com">EUR</currency>
              <value xmlns="http://common.services.adyen.com">1130</value>
            </amount>
            <eventCode>AUTHORISATION</eventCode>
            <eventDate>2019-06-28T18:03:50+01:00</eventDate>
            <merchantAccountCode>YOUR_MERCHANT_ACCOUNT</merchantAccountCode>
            <merchantReference>YOUR_TRANSACTION_REFERENCE</merchantReference>
            <operations xsi:ns1="true" />
            <reason  xsi:ns1="true" />
            <originalReference xsi:ns1="true" />
            <paymentMethod>visa</paymentMethod>
            <pspReference>7914073381342284</pspReference>
            <success>true</success>
          </NotificationRequestItem>
        </notificationItems>
      </ns1:Notification>
    </ns1:sendNotification>
  </soap:Body>
</soap:Envelope>

Some fields included in the NotificationRequestItem object depend on the type of event that triggered the notification. For example, notifications triggered by a request to refund a payment include:

• originalReference: The pspReference of the original payment.

For more information about the fields included in specific notifications, refer to Event codes.

Event codes

Default event codes are, by default, included in Standard notifications. Non-default event codes require additional configuration to enable.

Because we sometimes create new event codes and types, you should set up your notification server to be able to receive more values than what is listed below.

Default event codes

By default, Standard notifications include notifications with the following eventCode values. There are different categories of event codes:

• Transaction events
• Dispute events
• Payout events

Transaction events

Dispute events

For more information and examples, refer to Dispute notifications.

Payout events

For more information and examples, refer to Payout notifications.

Non-default event codes

There are additional event codes that are not enabled in Standard notifications by default. You can configure these to be enabled or disabled:

• In the Webhook settings page
• With additional configuration

In the Webhook settings page

You can enable the following eventCode values on the Webhook settings page.

1. Log in to your Customer Area.
2. Go to Developers > Webhooks.
3. Select the Settings button.
4. Under Webhook settings, select the checkboxes for the event codes you want to enable and deselect checkboxes the for the ones you want to disable.

With additional configuration

You need to contact our Support Team to receive the following eventCode values.

Other notifications

In addition to Standard Notifications, you can set up separate endpoints to receive specific types of notifications:

1. Log in to your Customer Area.
2. Go to Developers > Webhooks.
3. In the upper-right corner, select the + Webhook button.
4. Find the webhook that you want to add, then select Add next to it.
5. Configure the notification as described in Set up notifications.

See also