Skip to content
Longport WhaleLongport Whale
Margin Call

Cash Details

Returns the cash-book details for a given user.

Request parameters

  • Required: aaid (securities account)
  • See the field definitions for each field's format, allowed values, and business meaning.

Returns

On success, returns the user's cash-book detail records. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/cash_book_details

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_detailed

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

Request body application/json

aaidstringrequired

A/C No.

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.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
cash_booksarray<object>

Cash details by currency.

Child attributes
currencystring

Currency.

ledger_balancestring

Ledger balance (amount string with thousands separators).

settled_balancestring

Settled balance.

unsettled_balancestring

Unsettled balance.

settled_frozen_balancestring

Settled frozen amount.

unsettled_frozen_balancestring

Unsettled frozen amount.

to_currency_ledger_balancestring

Converted ledger balance (numeric string without thousands separators).

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