Balance Blocking Rules

Query the balance-interception rule configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains balance-interception rules per bank account — bank code, account number, business type, status, currency, prompt balance and interception balance; prompts or blocks the related business when the balance hits a threshold.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_balance_rules

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_risk_withdraw.risk_balance_rules_query

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

biz_typestring

Filters results by Business Type.

Allowed values: 1 withdraw, 2 forex

Values

1: withdraw
2: forex

rule_statusstring

Filters results by Status.

Allowed values: 1 on, 2 off

Values

1: on
2: off

bank_codestring

Filters results by Bank Code.

bank_accountstring

Filters results by Account No.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Balance Blocking Rules records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

bank_codestring

Returned value: Bank Code.

bank_accountstring

Returned value: Account No.

biz_typestring

Returned value: Business Type.

biz_type_valstring

Raw value of biz_type. The biz_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

rule_statusstring

Returned value: Status.

rule_status_valstring

Raw value of rule_status. The rule_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Returned value: Currency.

warning_amountstring

Returned value: Warning Amount.

intercept_amountstring

Returned value: Intercept Amount.

updated_atstring

Returned value: Modified At. The date or time format follows the value returned by the API.

modify_operatorstring

Returned value: Processed By.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_balance_rules' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "bank_code": "072",
        "bank_account": "Zhang San",
        "biz_type": "Forex",
        "biz_type_val": "2",
        "rule_status": "Off",
        "rule_status_val": "2",
        "currency": "USD",
        "warning_amount": "555",
        "intercept_amount": "666",
        "updated_at": "1769571199",
        "modify_operator": "Zhang San"
      }
    ],
    "total": 7
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_balance_rules/download

lb_hk_risk_withdraw.risk_balance_rules_export

Export options Export records Download result