SCHEDULED_REFUNDS

After refunds were triggered by the /refundNotPaidOutTransfers request , Adyen sends out this notification containing the scheduled refunds.

It will also inform you of expected refunds, and whether the scheduling was:

  • Successful: response = "[cancelOrRefund-received]"
  • Unsuccessful: response = "SOME_ERROR_MESSAGE"

Common fields

The table below lists the fields that are present in each Adyen MarketPay notification and provide general information about the event that triggered this notification.

Name Type Returned by default Description
eventType String (tick)

This notification event's type.

For this event, it is SCHEDULED_REFUNDS.

eventDate DateTime (tick)

NEW IN V4 The date and time when an event has been completed.

executingUserKey String (tick)

A user or process that has triggered the notification.

live Boolean (tick)

Informs about the origin of the notification:

  • true: the notification originated from the live environment.
  • false: the notification originated from the test environment.
pspReference String (tick) PSP Reference of the notification.
content Object (tick)

Notification message content, which is specific for each notification type.

For the detailed description of its structure, see the table below.

Content field structure

The content field of this notification contains the following elements.

Name Type Returned by default Description
accountHolderCode String (tick)

A code identifying the account holder.

accountCode String (tick) A code identifying the account.
lastPayout Transaction (error)

Last payout details.

refundResults Array (tick)

Containers for refund results. If there were no transfers to be refunded, this array is empty.

This array contains the RefundResult elements.

Code example

{
   "eventType":"SCHEDULED_REFUNDS",
   "eventDate":"2018-04-23T13:13:44+02:00",
   "executingUserKey":"ws",
   "live":true,
   "pspReference":"9914748996740271",
   "content":{
      "accountCode":"1234567890",
      "accountHolderCode":"TestAccountHolder",
      "lastPayout":{
         "amount":{
            "currency":"EUR",
            "value":5000
         },
         "creationDate":"2016-10-14T09:38:53+02:00",
         "description":"Test reference - Test description",
         "pspReference":"9914748988390044",
         "transactionStatus":"PAYOUT"
      },
      "refundResults":[
         {
            "RefundResult":{
               "originalTransaction":{
                  "amount":{
                     "currency":"EUR",
                     "value":5000
                  },
                  "creationDate":"2016-10-14T09:38:53+02:00",
                  "description":"Test reference - Test description",
                  "pspReference":"9914748990310097",
                  "transactionStatus":"PENDING_CREDIT"
               },
               "pspReference":"9914748990680119",
               "response":"[cancelOrRefund-received]"
            }
         },
         {
            "RefundResult":{
               "originalTransaction":{
                  "amount":{
                     "currency":"EUR",
                     "value":5000
                  },
                  "creationDate":"2016-10-14T09:38:53+02:00",
                  "description":"Test reference - Test description",
                  "pspReference":"9914748996740271",
                  "transactionStatus":"PENDING_CREDIT"
               },
               "pspReference":"9914748998330311",
               "response":"Could not determine merchantAccount"
            }
         },
         {
            "RefundResult":{
               "originalTransaction":{
                  "amount":{
                     "currency":"EUR",
                     "value":5000
                  },
                  "creationDate":"2016-10-14T09:38:53+02:00",
                  "description":"Test reference - Test description",
                  "pspReference":"9914748990310097",
                  "transactionStatus":"PENDING_CREDIT"
               },
               "pspReference":"9914748988390044",
               "response":"Failed to send refund: Service unavailable"
            }
         }
      ]
   }
}