Skip to content
Longport WhaleLongport Whale
Balance Blocking Rules

Edit Balance Blocking Rule

Edit a single balance-interception rule, updating its warning balance and interception balance.

Request parameters

  • Required: id (rule ID), warning_amount (warning balance), intercept_amount (interception balance).
  • id locates the rule to edit; warning_amount and intercept_amount are non-negative integer amounts, in the currency configured on the rule itself.
  • See the individual field descriptions for each field's format, allowed values, and business meaning.

Risk warning

This changes real balance-interception thresholds and may affect whether withdrawal requests are warned or intercepted. Verify the target rule and amounts before calling.

Result

On success, the rule's warning and interception balances are updated; data carries no additional business fields.

POSThttps://b-api.lbkrs.com/atmrisk/modify_balance_rule

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_risk_withdraw.risk_balance_rules_modify

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

idstringrequired

ID of the balance blocking rule to edit, used to locate the target rule. This field is required.

warning_amountintegerrequired

Warning amount, a non-negative integer. A warning is triggered when the account balance falls below this threshold. The currency follows the rule's own configuration. This field is required.

intercept_amountintegerrequired

Intercept amount, a non-negative integer. Withdrawals are intercepted when the account balance falls below this threshold. The currency follows the rule's own configuration. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs