Settlement Transactions

Query the settlement transaction records. 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/booking_settlement_records

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_settlement.turnover_query

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

settlement_channelstring

Filters results by Settlement Channel.

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

directionstring

Filters results by Trade Direction.

1 · Buy2 · Sell

marketstring

Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

US · USHK · HKUK · UKSH · SHSZ · SZSG · SGKR · KRJP · JPAU · AUDE · DECA · CATH · THId · IDMY · MYTR · TRNA · NAOSL · OSLHAS · HASEU · EUUT · UTGTMMF · GTMMF

currencystring

Filters results by Currency.

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

counter_idstring

Filters results by Counter ID.

expected_settlement_dateobject

Filters results by Expected Settlement Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

task_nostring

Filters results by Settlement Batch No.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Settlement Transactions 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_nostring

Returned value: Batch No.

nostring

Returned value: No.

settlement_channelstring

Returned value: Settlement Channel.

settlement_channel_valstring

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

settlement_accountstring

Returned value: Settlement Account.

aaidstring

Returned value: A/C No..

aaid_valstring

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

biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

directionstring

Returned value: Trade Direction.

direction_valstring

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

marketstring

Returned value: Market.

counter_idstring

Returned value: Counter ID.

trade_quantitystring

Returned value: Trade Quantity.

currencystring

Returned value: Currency.

trade_amountstring

Returned value: Trade Amount.

expected_settlement_datestring

Returned value: Expected Settlement 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.

settled_atstring

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

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

amountstring

Returned value: Fee.

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/booking_settlement_records' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "task_no": "batch2026071510020",
        "no": "OS2026071610152",
        "settlement_channel": "settlement_ex_hk & CCASS",
        "settlement_channel_val": "5",
        "settlement_account": "",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "biz_type": "Stock Trade",
        "biz_type_val": "1",
        "direction": "Buy",
        "direction_val": "1",
        "market": "SH",
        "counter_id": "ST/SH/600519",
        "trade_quantity": "500",
        "currency": "CNH",
        "trade_amount": "609,950",
        "expected_settlement_date": "2026-07-15",
        "trade_date": "2026-07-14",
        "settled_at": "",
        "updated_at": "1784185008",
        "amount": "0"
      }
    ],
    "total": 219590
  }
}