Channel Exchange Order

Query channel exchange orders, a bookkeeping entry data source that records currency-exchange orders processed through channels.

Request parameters

Combine business filters through filters (available fields are documented under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from channel exchange orders; each record notes the business type, exchange type, and channel, along with the client exchange order number and the channel exchange order number.
Records include the amount, currency, accounting date, and trade date, matched against the channel-side conversion handling.
It is commonly used to reconcile currency-exchange fund movements and serves as the source voucher for generating accounting entries.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

book.channel_exchange_order_inquiry

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

Request body application/json

filtersobject

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

Child attributes

account_atobject

Filters results by Account Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

business_typestring

Filters results by Business Type.

Allowed values: ChannelExchange Channel Exchange, ChannelExchangeEntry Channel Exchange Entry, ExchangeGains Exchange Gains, ExchangeLoss Exchange Loss

Values

ChannelExchange: Channel Exchange
ChannelExchangeEntry: Channel Exchange Entry
ExchangeGains: Exchange Gains
ExchangeLoss: Exchange Loss

currencystring

Filters results by Currency.

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

idstring

Filters results by ID.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Channel Exchange Order 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

idstring

Returned value: Unique identifier of the current record.

business_typestring

Returned value: Business Type.

business_type_valstring

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

amountstring

Returned value: Amount.

currencystring

Returned value: Currency.

forex_typestring

Returned value: Type.

account_atstring

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

trade_atstring

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

user_order_nostring

Returned value: Conversion Order No..

channel_order_nostring

Returned value: Channel Conversion Order No..

channelstring

Returned value: Channel.

created_atstring

Returned value: Created At. 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.

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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/clearing_channel_exchange_orders' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "120896",
        "business_type": "Exchange Loss",
        "business_type_val": "ExchangeLoss",
        "amount": "-0.38",
        "currency": "USD",
        "forex_type": "FROM",
        "account_at": "2026-06-16",
        "trade_at": "2026-06-16",
        "user_order_no": "2027447321",
        "channel_order_no": "2012044776327",
        "channel": "ICBCASIA",
        "created_at": "1781557377",
        "updated_at": "1781557377"
      }
    ],
    "total": 374
  }
}

Export

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

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

book.channel_exchange_order_inquiry

Export options Export records Download result