Skip to content
Longport WhaleLongport Whale
Settlement

Private Fund Clearing Reconciliation

Query the private fund settlement reconciliation data, used to reconcile broker channel orders against fund company confirmations day by day and drive settlement.

Request parameters

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

Business notes

The data is keyed by channel order, consolidating a trading day's subscription/redemption figures with the fund company's confirmations for the settlement team to reconcile and settle.

Each record carries the channel order ID, fund code, external fund code, ISIN, trading day, currency, fund channel, NAV, applied subscription amount, applied redemption shares, fund-company-confirmed subscription shares, confirmed net redemption amount, data status, settlement status, and remark.

Typically filtered by trading date, fund channel, fund code, or external fund code to verify that subscription/redemption figures match the fund company and to track settlement progress.

Returns

On success, returns the matched records and pagination information. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_fund_orders_verification.fund_orders_verification_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
company_channelstring

Company Channel. Filters results by Company Channel.

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

dtobject

Trading Date. Filters results by Trading Date.

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.

counter_idstring

Fund Code. Filters results by Fund Code.

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

Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

external_fund_class_idstring

External Fund Code. Filters results by External Fund Code.

isinstring

ISIN. Filters results by ISIN.

counter_id_pstring

Pcounter ID. Filters results by Pcounter ID.

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

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 Private Fund Clearing Reconciliation 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

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

counter_idstring

Fund Code. Returned value: Fund Code.

navstring

NAV. Returned value: NAV.

dtstring

Trading Day. Returned value: Trading Day.

currencystring

Currency. Returned value: Currency.

work_statestring

Data Status. Returned value: Data Status.

work_state_valstring

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

company_channelstring

Company Channel. Returned value: Company Channel.

rejection_remarkstring

Remark. Returned value: Remark.

apply_placement_amountstring

Apply Placement Amount. Returned value: Apply Placement Amount.

apply_redemption_sharesstring

Apply Redemption Shares. Returned value: Apply Redemption Shares.

confirmed_placement_sharesstring

Confirmed Placement Shares. Returned value: Confirmed Placement Shares.

confirmed_net_redemption_amountstring

Confirmed Net Redemption Amount. Returned value: Confirmed Net Redemption Amount.

external_fund_class_idstring

External Fund Code. Returned value: External Fund Code.

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

Whale Docs