API Reference

Update threshold for a managed balance

patch
https://api.staging.layer1.com/treasury/v1/managed-balances//thresholds

Update thresholds for a managed balance

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the managed balance

Body Params
number
required

Minimum balance in the native currency that must be maintained for the specified address.

  • Auto top-up source: If the balance falls below this threshold, a top-up may be triggered.

  • Liquidity source: Withdrawals will not be processed if they would reduce the balance below this threshold. If the requested withdrawal cannot be fully met, the system will attempt the next liquidity source; if none are available, the top-up will fail.

Usage: Enter the minimum balance this address should not drop below.

number

Balance amount that triggers a low balance notification for the specified address when reached.

number
required

Target balance threshold. For auto top-up sources, enter the amount to which the address balance should be restored when a top-up occurs. Not applicable for liquidity sources or intermediaries.

int32

For forecasting only. Time horizon, in hours, used to project whether a top-up is needed. If the forecasted balance within this window falls below the minimum balance, a top-up will be triggered. For example, a value of 2 means the system looks 2 hours ahead from the current time when evaluating the minimum balance.

int32

For forecasting only. Time horizon, in hours, used to project whether a low balance warning should be triggered. If the forecasted balance within this window falls below the warning threshold, a warning will be issued. For example, a value of 3 means the system looks 3 hours ahead from the current time when evaluating the warning balance.

int32

For forecasting only. Time horizon, in hours, used to determine the target balance when a top-up is triggered. If the forecasted balance at this future point is higher than the manually set target, the forecasted value will be used instead. For example, a value of 6 means the system looks 6 hours ahead from the current time to set the target balance.

number
≥ 0

Multiplier applied on top of the minimum balance when validating it as a source. For liquidity sources or intermediaries, the available balance must exceed the required amount by at least this factor.

For example, a value of 0.2 means the source must hold 20% more than the withdrawal amount to be eligible.

string

Maximum time, in hours, allowed for a top-up to complete. If the operation does not finish within this period, it will not be retried.

Responses

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?