BENEFICIARY_SETUP

After a beneficiary was set up by the /setupBeneficiary request, Adyen sends out this notification containing the details.

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 BENEFICIARY_SETUP.

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
destinationAccountCode String (tick)

The account that receives transactions of the beneficiary.

destinationAccountHolderCode String (tick)

The owner of the destination account.

merchantReference String (tick)

The reference that a merchant provides to identify a reason for setting up a beneficiary.

sourceAccountCode String (tick)

The account, from which all transactions are moved to the beneficiary.

sourceAccountHolderCode String (tick)

The owner of the source account.

transferDate Date/Time (tick) The date indicating when the beneficiary was setup; all transactions before this date are transferred.
transferredTransactionCount Int (tick) The number of transactions that were transferred with this setup.

Code example

{
   "eventType":"BENEFICIARY_SETUP",
   "eventDate":"2018-04-23T13:13:44+02:00",
   "executingUserKey":"TestMarketPlace",
   "live":false,
   "pspReference":"9914855241150642",
   "content":{
      "destinationAccountCode":"147228646",
      "destinationAccountHolderCode":"TestAccountHolder14855240607989",
      "merchantReference":"Test",
      "sourceAccountCode":"192707713",
      "sourceAccountHolderCode":"TestAccountHolder14855240564397",
      "transferDate":"2017-01-27T14:35:15+01:00",
      "transferredTransactionCount":9
   }
}