Adyen-for-platform icon

Track balance updates

Learn about balance changes and how you can get notified about them.

Balance changes may occur as part of a payment lifecycle, or from financial products used on your platform's balance accounts. For example, the available balances increase when your users receive payments, and decrease when you trigger payouts from your users' balance accounts to their bank accounts, or when customers request a refund or chargeback from your users.

Adyen can send you webhooks to notify you when a balance change occurs:

  • In any of the balance accounts of your balance platform
  • In the balance accounts of specific account holders
  • In specific balance accounts

You can define the criteria for triggering the webhook based on your own requirements and preferences.

How it works

The following process describes how you can get notified about balance changes in your balance platform.

  1. You subscribe to the Balance webhook in your Customer Area and get the webhook ID.
  2. You configure the balance webhook settings using the Configuration API, specifying the webhook ID and criteria for triggering the webhook.
    You can get notified about balance changes for the following resources:
    • Balance platform: you receive webhooks for balance changes in all balance accounts in your balance platform.
    • Account holder: you receive webhooks for balance changes in all balance accounts of a specific user.
    • Balance account: you receive webhooks for balance changes in a specific balance account.
  3. When a balance change in the specified balance account in your platform meets all the conditions you set, Adyen sends a balance webhook to your server.

Hierarchy of settings

The webhook settings you configure on a higher level resource are inherited by all balance accounts connected to that resource. Settings you configure on a more granular level override the settings you configure on higher-level resources.

Level Resource Applies Overrides Inherits
3 Balance platform Applies to all balance accounts in your balance platform, unless otherwise specified. N/A N/A
2 Account holder Applies to all balance accounts of the user, unless otherwise specified. Overrides settings configured on a balance platform level. Inherits settings configured on the balance platform level.
1 Balance account Applies to the specific balance account only. Overrides settings configured on an account holder or balance platform level. Inherits settings configured on the balance platform or account holder level.

Next steps