Merchant account webhook specifications
Merchant account notifications are sent to your webhook URI registered in Console when certain merchant account-related events happen.
balance_notification
| Field | Type | Description |
|---|---|---|
type | string | The type of the event ("balance_notification") |
event_id | string | The unique UUID for that specific event. |
event_version | number | The version of the event schema. |
merchant_account_id | string | The ID of the merchant account this notification is about. |
current_balance_in_minor | number | The current balance of the merchant account this notification is about. |
available_balance_in_minor | number | The available balance of the merchant account this notification is about. |
threshold_in_minor | number | The threshold specified for this merchant account by contacting TrueLayer. The threshold should be an amount in minor. |
status | any | The status for a balance notification can be one of three values: - approaching_threshold: Returned when the merchant account balance is goes below 150% of the threshold_in_minor.- below_threshold: Returned when the merchant account balance goes below the threshold_in_minor.- recovered: Returned when the new merchant account balance exceeds 200% of the specified threshold after you top up your account. |
{
"type": "balance_notification",
"event_version": 1,
"event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
"merchant_account_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
"current_balance_in_minor": 1500,
"available_balance_in_minor": 1500,
"threshold_in_minor": 1000,
"status": "approaching_threshold"
}
Updated 10 months ago