Skip to content
Longport WhaleLongport Whale
Balance Blocking Rules

Switch Balance Rule

Enable or disable a balance-interception rule.

Request parameters

  • Required: id (rule ID), rule_switch (rule toggle).
  • id locates the target rule.
  • See the individual field descriptions for each field's format, allowed values, and business meaning.

Risk warning

This changes whether a real balance-interception rule is in effect and may affect whether withdrawal requests are intercepted. Confirm the target rule before calling.

Result

On success, the rule's enabled state is toggled; the resulting state and returned data follow the 200 response definition.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_risk_withdraw.risk_balance_rules_enable

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

Request body application/json

idstringrequired

Rule ID associated with this request.

rule_switchbooleanrequired

Boolean flag for rule switch. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply

Responses

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

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