Exceed Credit Limit Details

Query accounts whose used financing exceeds their granted credit limit, so the risk team can identify and act on over-financing exposure.

Request parameters

Combine business filters through filters (see the filters field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data lists customer accounts whose used financing amount is above their granted credit / financing limit.
Each record carries customer information, account type, credit limit, financing limit, total used financing, the excess amount and excess ratio, plus the main and other settlement-book balances.
It provides the basis for risk actions on over-financing accounts, such as triggering a margin call.

Returns

On success, returns the matched records and pagination info. See the response schema for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_credit_limit.client_credit_limit_query

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

Request body application/json

filtersobject

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

Child attributes

aaidstring

AAID. Filters results by AAID.

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.

finance_amountobject

Financing Amt. Filters results by Financing Amt.

Child attributes

gteinteger

Greater Than or Equal. Inclusive lower bound of the filter range.

lteinteger

Less Than or Equal. Inclusive upper bound of the filter range.

used_financeobject

Used Financing Amt. Filters results by Used Financing Amt.

Child attributes

gteinteger

Greater Than or Equal. Inclusive lower bound of the filter range.

lteinteger

Less Than or Equal. Inclusive upper bound of the filter range.

account_typestring

Account Type. Filters results by Account Type.

Allowed values: M Margin, C Cash, F Futures

Values

M: Margin
C: Cash
F: Futures

markstring

Account Tag. Filters results by Account Tag.

Allowed values: dt Day Trade

Values

dt: Day Trade

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Excess Margin Usage Report records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

aaidstring

AAID. Returned value: AAID.

aaid_valstring

AAID (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

member_idstring

Member ID. Returned value: Member ID.

real_namestring

Name. Returned value: Name.

origin_idstring

A/C No. Returned value: A/C No.

account_typestring

Account Type. Returned value: Account Type.

account_type_valstring

Account Type (raw value). Raw value of account_type. The account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_markstring

Account Tag. Returned value: Account Tag.

account_mark_valstring

Account Tag (raw value). Raw value of account_mark. The account_mark field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_channelstring

Channel. Returned value: Channel.

credit_currencystring

Based Currency. Returned value: Based Currency.

finance_amountstring

Financing Amt. Returned value: Financing Amt.

used_financestring

Used Financing Amt. Returned value: Used Financing Amt.

main_used_financestring

Used Financing Amt (Based CCY). Returned value: Used Financing Amt (Based CCY).

other_used_financestring

Used Financing Amt (Other Curr). Returned value: Used Financing Amt (Other Curr).

exceed_amountstring

Excess Financing Amt. Returned value: Excess Financing Amt.

exceed_ratestring

Excess Financing Ratio. Returned value: Excess Financing Ratio.

main_settlement_book_balancestring

Settled Balance (Based CCY). Returned value: Settled Balance (Based CCY).

other_settlement_book_balancestring

Settled Balance (Other Curr). Returned value: Settled Balance (Other Curr).

totalintegerrequired

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "aaid": "H00000001",
        "aaid_val": "H00000001",
        "member_id": "101456715",
        "real_name": "张三",
        "origin_id": "1000000001",
        "account_type": "1",
        "account_type_val": "1",
        "account_mark": "1",
        "account_mark_val": "1",
        "account_channel": "longport_test",
        "credit_currency": "USD",
        "finance_amount": "125630.50",
        "used_finance": "string",
        "main_used_finance": "string",
        "other_used_finance": "string",
        "exceed_amount": "125630.50",
        "exceed_rate": "0.32",
        "main_settlement_book_balance": "125630.50",
        "other_settlement_book_balance": "125630.50"
      }
    ],
    "total": 1
  }
}