Skip to content
Longport WhaleLongport Whale
Settlement

Fund Clearing Processing Details

Query the per-order processing details of a fund settlement batch task, used to reconcile the task's successful, failed, and exception results.

Request parameters

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

Business notes

The data comes from the processing details of a fund settlement task; each record corresponds to one settlement order under the task.

Each record carries the order ID, fund code, securities account number, and, when processing fails, a remark with the error message.

Use task_id to select the operation record to inspect, and state to filter by processing status (processing, success, failed, exception; comma-join multiple values). Typically used after settlement to tally the success and failure counts of a task and to trace failure reasons.

Returns

On success, returns the matching record list with pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.ut_order

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

Request body application/json

filtersobject

Filters

Child attributes
task_idstring

Task Id

statestring

State. Multi-select; submit as a comma-joined string.

Allowed values: 0 Processing, 1 Processed successfully, 2 Processing failed, 3 Processing error

Values
0
1
2
3
pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

ref_idstring

Order ID

counter_idstring

Fund Code

origin_idstring

Account No

err_codestring

Remark

err_code_valstring

Remark (raw value). Raw value behind field err_code: err_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired

Total

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