Cash Account Balance

Query customer cash-account balances, used in the back office to reconcile each customer's per-currency book and frozen cash positions.

Request parameters

Use filters to combine business filter conditions (available fields are listed under the filters field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data comes from the settlement/trading system's cash-account ledger; each record is one customer's cash balance for a given account type and currency.

Each record carries customer info (member ID, name, securities account number), account type, currency, book balance, unavailable (frozen) amount, and the last update time.

Typically used for cash reconciliation, tracing frozen amounts, and customer-service inquiries.

Returns

On success, returns the matching records with pagination info. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance.account

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

Client. 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.

currencystring

Currency. Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

account_typestring

Account Type. Filters results by Account Type.

Allowed values: SETTLEMENT, BUSINESS, EXTERNAL, INTERNAL

Values

SETTLEMENT
BUSINESS
EXTERNAL
INTERNAL

updated_atobject

Updated At. Filters results by Updated At.

Child attributes

gtestring

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

ltestring

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

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

HTTP 200On success, returns paginated Cash Account Balance 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

idstring

ID. Returned value: Unique identifier of the current record.

member_idstring

Member ID. Returned value: Member ID.

real_namestring

Name. Returned value: Name.

real_name_valstring

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

origin_idstring

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

account_typestring

Account Type. Returned value: Account Type.

currencystring

Currency. Returned value: Currency.

currency_valstring

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

custom_unavailable_amountstring

Frozen Balance. Returned value: Frozen Balance.

book_balancestring

Total Balance. Returned value: Total Balance.

updated_atstring

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

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "7496263",
        "member_id": "101456715",
        "real_name": "Zhang San",
        "real_name_val": "",
        "origin_id": "H00000000",
        "account_type": "SETTLEMENT",
        "currency": "CNH",
        "currency_val": "CNH",
        "custom_unavailable_amount": "",
        "book_balance": "1,000,000,000.00",
        "updated_at": "1784185026"
      }
    ],
    "total": 0
  }
}

Export

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

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

account_balance.account

Export options Export records Download result