Webhooks for card payouts

When a payout is triggered in your platform, Adyen sends the following kinds of webhooks:

• balancePlatform.transfer.created, which informs your server that an outgoing transfer is initiated from a balance account in your platform.
• balancePlatform.transfer.updated, which informs your server of the transfer status changes.

This page explains how to identify webhooks related to card payouts and shows examples for the webhooks that you receive for every transfer status.

Requirements

To keep track of payout-related events in your balance platform, ensure that:

• Your server can receive and accept webhooks.
• You subscribed to Transfer webhooks and Transaction webhooks in your Balance Platform Customer Area.

Identify payout-related webhooks

You can identify transfer webhooks triggered by payout-related events by looking at the following values:

Adyen sends webhooks for the following payout events:

• Payout initiated
• Payout authorised
• Payout booked
• Payout pending
• Payout failed

The following sections provide code samples for the events that trigger webhooks. These samples consider a use case where you pay out EUR 100.00 from a balance account to a Mastercard or Visa card.

Payout initiated

When your user initiates a transfer to a Mastercard or Visa card, Adyen sends a balancePlatform.transfer.created webhook to inform your server that an outgoing transfer request has been created. The webhook provides information about the transfer, such as:

• The amount of the payout.
• The balanceAccount from which the payout funds will be deducted.
• The accountHolder linked to the balance account.
• The counterparty information.
• The bookingDate when the payout was requested.
• The id of the corresponding transfer.

The following tabs show examples of balancePlatform.transfer.created webhooks for one-off and recurring payouts.

Payout authorised

When the transfer request for the payout is authorised, Adyen sends a balancePlatform.transfer.updated webhook to inform your server that the transfer amount has been reserved on the account. This webhook includes the status authorised.

The following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.

Payout booked

When the funds are deducted from your user's balance account, Adyen sends a balancePlatform.transfer.updated webhook with:

• direction: outgoing
• status: booked
• events.transactionId: ID of the transaction

This status is not final. The transfer may still fail if, for example, the transfer is rejected by the scheme or issuing bank.

The following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.

Payout pending

After the funds are deducted from your user's balance account, the transfer is automatically analyzed to ensure that it complies with Adyen's policies. If a transfer is flagged, Adyen reviews the transfer.

In order to speed up the screening process and reduce the amount of manual effort needed, we recommend that you provide as much information as possible in the transfer request. For example, include all counterparty details in the accountHolder object.

In this case, Adyen sends a balancePlatform.transfer.updated webhook with a tracking event, specifying the following trackingData details:

• status: pending
• type: internalReview

The following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.

If the transfer fails Adyen's review process, we send a balancePlatform.transfer.updated webhook with a tracking event, specifying the following trackingData:

• reason: refusedForRegulatoryReasons
• status: failed
• type: internalReview

If this is the case, contact our Support Team.

Payout failed

The payout transfer can fail if it is rejected by an external banking system and any automatic retries are unsuccessful.

When a payout transfer fails, Adyen sends a balancePlatform.transfer.updated webhook with:

• status: failed
• The transactionId
• The reason for the failure. For more information, see Reason codes.

The following tabs show examples of balancePlatform.transfer.updated webhooks for one-off and recurring payouts.