Trade Reconciliation Configuration

Query the settlement-channel configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains settlement channels under each provider — broker id/name, settlement channel, trade type, reconciliation tolerance threshold, seat filter, reconciliation mode and remark; used to configure the channel parameters for trade reconciliation and settlement.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_settlement_channels

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

Request body application/json

filtersobject

Child attributes

custodian_idstring

Filters results by Broker ID.

custodian_namestring

Filters results by Broker name.

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

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

channel_typestring

Trade type. Returned value: Trade type of the settlement channel (display value; the raw code is in the matching _val field).

channel_type_valstring

Raw value of channel_type. The channel_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

tolerance_thresholdstring

Tolerance threshold. Returned value: Tolerance threshold for trade reconciliation (numeric string).

account_modestring

Broker no. filtering. Returned value: Broker number filtering mode (display value; the raw code is in the matching _val field).

account_mode_valstring

Raw value of account_mode. The account_mode field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

verify_accountsstring

Broker no.. Returned value: Broker numbers used for filtering; may be an empty string.

verifiedstring

Trade recon type. Returned value: Trade reconciliation mode (display value; the raw code is in the matching _val field).

verified_valstring

Raw value of verified. The verified field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Remark. Returned value: Remark; may be an empty string.

updated_atstring

Updated at. Returned value: Unix timestamp in seconds, returned as a string.

updated_bystring

Updated by. Returned value: Back-office account that last updated the record.

totalintegerrequired

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "channel_type": "1",
        "channel_type_val": "1",
        "tolerance_threshold": "string",
        "account_mode": "1",
        "account_mode_val": "1",
        "verify_accounts": "string",
        "verified": "string",
        "verified_val": "1",
        "remark": "审核通过",
        "updated_at": "1789713827",
        "updated_by": "张三"
      }
    ],
    "total": 1
  }
}

Export

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

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

lb_hk_clearing.clearing_settlement_channels

Export options Export records Download result