Client Fast Repayment Tier Limit Settings

Query the client-level express-payout limit 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 per-client express-payout (over-limit withdrawal) limits, used to grant specific clients a dedicated fast-withdrawal quota.

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/account_exceeding_withdraw_limit_configs

Authorization

AuthorizationstringheaderRequired

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

Permission

risk_config.withdrawal_limit_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

aaidstring

Filters results by Client.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Client Fast Repayment Tier Limit Settings 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

origin_idstring

Returned value: A/C No.

real_namestring

Returned value: Client Name.

is_applystring

Returned value: Indicates whether status.

is_apply_valstring

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

currencystring

Returned value: Currency.

quotastring

Returned value: Quota Limit.

last_update_userstring

Returned value: Operator.

updated_atstring

Returned value: Operating Time. The date or time format follows the value returned by the API.

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/account_exceeding_withdraw_limit_configs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "origin_id": "H00000000",
        "real_name": "Zhang San",
        "is_apply": "Effective",
        "is_apply_val": "true",
        "currency": "HKD",
        "quota": "1,000.00",
        "last_update_user": "user@example.com",
        "updated_at": "1782182679"
      }
    ],
    "total": 0
  }
}

Export

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

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

risk_config.withdrawal_limit_query

Export options Export records Download result