Adyen sends balance webhooks to notify you of balance changes in your balance platform. They can be triggered when the balance reaches, exceeds, or drops below a specific value in a specific currency.
You can get notified about balance changes in your entire balance platform, in the balance accounts of a specific user, or a specific balance account. The hierarchy between the webhook settings are based on the following business logic:
Settings on a higher level apply to all lower level resources (balance platform > account holder > balance acocunt).
The most granular setting overrides higher level settings (balance account > account holder > balance platform).
The status of the webhook setting. Possible values:
active: You receive a balance webhook if any of the conditions in this setting are met.
inactive: You do not receive a balance webhook even if the conditions in this settings are met.
targetobjectRequired
The type and ID of the resource about whose balance changes you want to be notified.
idstringRequired
The unique identifier of the target.type. This can be the ID of your:
balance platform
account holder
account holder's balance account
typestringRequired
The resource for which you want to receive notifications. Possible values:
balancePlatform: receive notifications about balance changes in your entire balance platform.
accountHolder: receive notifications about balance changes of a specific user.
balanceAccount: receive notifications about balance changes in a specific balance account.
typestringRequired
The type of the webhook you are configuring. Set to balance.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.