Clearing - Trade Transaction Reconciliation Differences

Query the trade-transaction reconciliation difference details. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_trade_order_check_diffs

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_steps

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

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

ledger_datestring

Filters results by Executive Date(Sys Date).

marketstring

Filters results by Market.

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

settlement_channel_codestring

Filters results by Broker.

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

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Unmatched Details records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

task_idstring

Returned value: Task ID.

ledger_datestring

Returned value: Executive Date(Sys Date). The date or time format follows the value returned by the API.

trade_datestring

Returned value: Trade Date. The date or time format follows the value returned by the API.

settlement_channel_codestring

Returned value: Custodian.

settlement_channel_code_valstring

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

settlement_accountstring

Returned value: Sub Account/Broker No..

marketstring

Returned value: Market.

account_nostring

Returned value: A/C No..

clearing_counter_idstring

Returned value: Counter ID(Local ).

other_counter_idstring

Returned value: Counter ID(Broker).

clearing_currencystring

Returned value: Currency(Local ).

other_currencystring

Returned value: Currency(Broker ).

clearing_idstring

Returned value: Ref No (Local).

other_idstring

Returned value: Ref No (Broker).

clearing_pricestring

Returned value: Price (Local).

other_pricestring

Returned value: Price (Broker).

clearing_quantitystring

Returned value: Quantity (Local).

other_quantitystring

Returned value: Quantity (Broker).

clearing_amountstring

Returned value: Amount (Local).

other_amountstring

Returned value: Amount (Broker).

clearing_indicatorstring

Returned value: Trade Direction (Local).

clearing_indicator_valstring

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

other_indicatorstring

Returned value: Trade Direction (Broker).

other_indicator_valstring

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

result_tagstring

Returned value: Reconciliation Result (Details).

result_tag_valstring

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

downgrade_statusstring

Returned value: Result Match By Stock.

downgrade_status_valstring

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

pricestring

Returned value: Difference (Price).

quantitystring

Returned value: Difference (Qty).

amountstring

Returned value: Difference (Amt).

verifiedstring

Returned value: Match Type.

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.

custodian_idstring

Returned value: Custodian.

custodian_id_valstring

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

tolerance_thresholdstring

Returned value: Tolerance.

tolerance_statusstring

Returned value: Tolerance Match Result.

tolerance_status_valstring

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

totalintegerrequired

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_trade_order_check_diffs' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "task_id": "string",
        "ledger_date": "string",
        "trade_date": "string",
        "settlement_channel_code": "string",
        "settlement_channel_code_val": "string",
        "settlement_account": "string",
        "market": "string",
        "account_no": "string",
        "clearing_counter_id": "string",
        "other_counter_id": "string",
        "clearing_currency": "string",
        "other_currency": "string",
        "clearing_id": "string",
        "other_id": "string",
        "clearing_price": "string",
        "other_price": "string",
        "clearing_quantity": "string",
        "other_quantity": "string",
        "clearing_amount": "string",
        "other_amount": "string",
        "clearing_indicator": "string",
        "clearing_indicator_val": "string",
        "other_indicator": "string",
        "other_indicator_val": "string",
        "result_tag": "string",
        "result_tag_val": "string",
        "downgrade_status": "string",
        "downgrade_status_val": "string",
        "price": "string",
        "quantity": "string",
        "amount": "string",
        "verified": "string",
        "verified_val": "string",
        "custodian_id": "string",
        "custodian_id_val": "string",
        "tolerance_threshold": "string",
        "tolerance_status": "string",
        "tolerance_status_val": "string"
      }
    ],
    "total": 0
  }
}