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. |
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. |
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:
|
notificationItems |
Array of NotificationRequestItem objects | ![]() |
A container object for the details included in the notification. |
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. |
A container object for the details referring to a single transaction.
Field | Type | Required | Description |
---|---|---|---|
additionalData
|
Object | ![]() |
The 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. WheneventCode 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.
|
merchantAccountCode
|
String |
![]() |
The merchant account identifier used in the transaction the notification item refers to. |
operations
|
List | ![]() |
This field holds a list of the modification operations supported by the transaction the notification item refers to.
The available operations in the list give information on the follow-up actions concerning the payment.
Possible values:
This field is populated only in authorisation notifications . In case of HTTP POST notifications, the operation list is a sequence of comma-separated string values. |
merchantReference
|
String |
![]() |
A reference to uniquely identify the payment.
By default,
Modification requests do not require sending a merchant reference value along with the call.
An empty
|
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
|
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 (
When |
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: |
---|---|
|
Format: 6-digit auth code:last 4 digits:expiry date Example:
|
|
reason
includes a short message with an explanation for the refusal.
|
|
reason
includes the download URL where you can obtain a copy of the report.
|
|
|
A container object for the additionalData
that can be returned in a notification referring to a single transaction.
Field | Type | Required | Description |
---|---|---|---|
shopperReference |
String | ![]() |
The ID that uniquely identifies the shopper. This 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:
|
cardSummary |
String | ![]() |
Returns the last 4 digits of the credit card. Only digits allowed. No alphabetic characters. |
expiryDate |
String | ![]() |
Returns the card expiry date.
|
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:
|
authorisedAmountCurrency |
String | ![]() |
Currency of the authorised amount. |