Low balance notifications
Set up webhook notifications to know when the balance of your merchant account is running low.
You can contact TrueLayer to specify a balance that you don't want your merchant account to go below. This helps ensure that you always have sufficient funds to make payouts to customers when needed.
This is especially useful if your integration is focused on payouts to external accounts, or if you sweep funds regularly.
If you have contacted TrueLayer and specified a balance threshold, you receive a merchant account webhook: balance_notification
. This webhook contains the balance in your account, and also a status
object. The status object can have a value of:
approaching_threshold
, which you receive when the balance is within 150% of the value of the specified threshold.below_threshold
, which you receive when the balance goes under your specified threshold.recovered
, which you receive when the merchant account balance exceeds 200% of the specified threshold after you top up your account.
For example, if you specified a balance of 1000, you would receive the:
approaching_threshold
webhook notification at a balance of 1500 or under.below_threshold
webhook notification at a balance of 1000 or under.recovered
webhook notification at a balance of 2000 or above after you top up your account frombelow_threshold
.
Updated 10 months ago