Notifications API reference

Indicators used in this section:


	This field is mandatory and must be always present.
	This field is optional and may be required in specific scenarios.

NotificationRequest

These are the fields that can be included in a notification message.

Field Type Required Description

live

String

Informs about the origin of the notification:

true: the notification originated from the live environment.
false: the notification originated from the test environment.

notificationItems Array of NotificationRequestItem objects A container object for the details included in the notification.

Amount

This object provides fields to hold information on the funds amount.

Field Type Required Description

currency String The three-character ISO currency code.

value

Int

The payable amount that can be charged for the transaction.

The transaction amount needs to be represented in minor units according to the following table.

NotificationRequestItem

A container object for the details referring to a single transaction.

Field	Type	Description
`additionalData`	Object	The `additionalData` object is a generic container that can hold extra fields. For more information, refer to NotificationRequestItem.additionalData .
`amount`	Amount	A container object for the payable amount information for the transaction. For HTTP POST notifications, currency and value are returned as URL parameters.
`pspReference`	String	Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request. In REPORT_AVAILABLE response you receive a file name in this field. In PAIDOUT_REVERSED event code pspsreference is for Capture's pspsreference.
`eventCode`	String	The type of event the notification item refers to. When `eventCode` returns `AUTHORISATION`, it does not necessarily mean that the payment authorisation request has been successfully processed. The authorisation is successful if `success` = `true`. If `success` = `false`, check the the `reason` value for further information on the authorisation failure cause. This can occur, for example, if an error occurs or if the transaction is refused.
`eventDate`	String	The time when the event was generated. Format: ISO 8601 ; YYYY-MM-DDThh:mm:ssTZD Example: 2017-07-17T13:42:40+01:00
`merchantAccountCode`	String	The merchant account identifier used in the transaction the notification item refers to.
`operations` Experimental	List	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. The modification operations that may be relevant for the transaction. The operations in the list indicate supported follow-up actions concerning the payment. Possible values are: `CAPTURE`: Capture the payment (for example, if auto-capture is not set up). `CANCEL`: Cancel the payment (if the payment has not been captured yet). `REFUND`: Refund the payment (if the payment has already been captured). This field is populated only in authorisation notifications . In case of HTTP POST notifications, the operations list is a sequence of comma-separated string values.
`merchantReference`	String	A reference to uniquely identify the payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, you can enter them in this field. Separate each reference value with a hyphen character ("`-`"). This field has a length restriction: you can enter max. 80 characters. By default, `merchantReference` is always returned with payment notifications , as `merchantReference` returns the `reference` field value of the corresponding payment request. In this case, returned by default = white_check_mark Modification requests do not require sending a merchant reference value along with the call. Therefore, the corresponding notifications do not include it by default. In this case, returned by default = An empty `merchantReference` field in a notification message takes `null` as a value.
`originalReference`	String	If the notification item is about a payment authorisation, this field is not populated and is blank. If the notification item is about a modification, the `originalReference` value corresponds to the payment request assigned to the original payment.
`paymentMethod`	String	The payment method used in the transaction the notification item refers to. Example payment methods that can be set to this field: visa , mc , ideal , elv , wallie , and so on.
`reason`	String	This field is included only in some notifications. This field holds plain text. For more information, refer to the reason field values below.
`success`	String	Informs about the outcome of the event ( `eventCode` ) the notification refers to: `true` : the event ( `eventCode` ) the notification refers to was executed successfully. `false` : the event was not executed successfully. When `eventCode` returns `AUTHORISATION`, it does not necessarily mean that the payment authorisation request has been successfully processed. The authorisation is successful if `success` = `true`. If `success` = `false`, check the the `reason` value for further information on the authorisation failure cause. This can occur, for example, if an error occurs or if the transaction is refused.

reason field values

The value of the reason field varies depending on whether the outcome of the event is successful or not (success = true or false):

If...	...then:
`eventCode` = `AUTHORISATION` `success` = `true` `paymentMethod` = `visa` , `mc` or `amex`	`reason` includes the following details: Authorisation code Last 4 digits of the card Card expiry date Format: 6-digit auth code:last 4 digits:expiry date Example: `874574:1935:11/2012`
`success` = `false`	`reason` includes a short message with an explanation for the refusal.
`eventCode` = `REPORT_AVAILABLE`	`reason` includes the download URL where you can obtain a copy of the report.
`eventCode` = `PAIDOUT_REVERSED`	`reason` field in the notification contains the bank statement description if present, else it contains `PaidOutReversed` .

NotificationRequestItem.additionalData

A container object for the additionalData that can be returned in a notification referring to a single transaction.

Field	Type	Description
`shopperReference`	String	The ID that uniquely identifies the shopper. This `shopperReference` is the same as the `shopperReference` used in the initial payment. This field is returned in case of recurring contract notifications.
`shopperEmail`	String	The shopper's email address. This field is returned in case of recurring contract notifications.
`authCode`	String	Authorisation code: When the payment is authorised successfully, this field holds the authorisation code for the payment. When the payment is not authorised, this field is empty.
`cardSummary`	String	Returns the last 4 digits of the credit card. Only digits allowed. No alphabetic characters.
`expiryDate`	String	Returns the card expiry date. Format: `MM/YYYY`
`authorisedAmountValue`	String	Value of the amount authorised. Scenario 1 - Zero value auth transaction Some issuers don't allow a zero value transaction. In this case Adyen authorises a minimum amount, for example Euro 1.00, to verify the shopper's card. After successful authorisation, Adyen's system automatically cancels the authorisation. The actual authorised amount is returned in this field which may differ from the amount sent in in the payment request. Scenario 2 - Available amount A shopper makes a transaction of Euro 10 using a gift card but the card contains only Euro 06. In this case, Adyen deducts the available amount and keeps the pending amount open to be completed with other payment options. The authorised amount is returned in this field. You can enable this feature in your Customer Area: Go to Settings > Server Communication. Next to Standard Notification, click Edit & Test. Under Additional Settings, toggle Include Authorised Amount (dynamic zero auth). Click Save Configuration.
`authorisedAmountCurrency`	String	Currency of the authorised amount.

Are you looking for test card numbers?