Channel Exchange Order

Query channel FX conversion orders, used to track and reconcile the execution of client exchanges on the external conversion channel side.

Request parameters

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

Business notes

The data source is the execution order created on the conversion channel side for a client FX conversion order; each record links to one client conversion order. Records can be searched by channel conversion order number, client conversion order number, exchange channel, debit/credit currency, exchange type, creation time, exchange completion time, channel exchange status, and exception status.
Each record carries the channel conversion order number and the linked client conversion order number, exchange channel, channel serial number, debit currency and amount, credit currency and amount, channel rate, channel exchange status, channel original status and returned information, exception status and manual remarks, and creation/completion times.
Typically used by operations and finance teams to reconcile channel execution results, investigate exception orders, and handle channel-returned information.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.channelexchangebill_query

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

Request body application/json

filtersobject

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

Child attributes

idstring

Channel Conversion Order No.. Filters results by Channel Conversion Order No..

forex_idstring

Conversion Order No.. Filters results by Conversion Order No..

channel_namestring

Exchange Channel. Filters results by Exchange Channel.

from_currencystring

Debit Currency. Filters results by Debit 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.

to_currencystring

Credit Currency. Filters results by Credit 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.

forex_typestring

Exchange Type. Filters results by Exchange Type.

Allowed values: FROM, TO

Values

FROM
TO

created_atobject

Created Time. Filters results by Created Time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

success_timeobject

Exchange Completion Time. Filters results by Exchange Completion Time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

channel_statusstring

Channel Exchange Status. Filters results by Channel Exchange Status.

Allowed values: SUBMITTED Submitted, PENDING Pending, APPROVED Approved, FAILED Failed, REJECTED Rejected, CANCELED Canceled

Values

SUBMITTED: Submitted
PENDING: Pending
APPROVED: Approved
FAILED: Failed
REJECTED: Rejected
CANCELED: Canceled

abnormal_statusstring

Exception Status. Filters results by Exception Status.

Allowed values: UNPROCESSED Unprocessed, WAIT_REVIEW Pending Review, TURN_SUCCESS Set as Successful, TURN_FAILURE Set as Failed, TURN_RETRY Re Exchange

Values

UNPROCESSED: Unprocessed
WAIT_REVIEW: Pending Review
TURN_SUCCESS: Set as Successful
TURN_FAILURE: Set as Failed
TURN_RETRY: Re Exchange

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

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

List. Returned value: List of list.

Child attributes

idstring

Channel Conversion Order No.. Returned value: Unique identifier of the current record.

forex_idstring

Conversion Order No.. Returned value: Conversion Order No..

channel_namestring

Exchange Channel. Returned value: Exchange Channel.

serial_nostring

Channel Journal. Returned value: Channel Journal.

forex_typestring

Exchange Type. Returned value: Exchange Type.

from_currencystring

Debit Currency. Returned value: Debit Currency.

from_amountstring

Debit Amount. Returned value: Debit Amount.

to_currencystring

Credit Currency. Returned value: Credit Currency.

to_amountstring

Credit Amount. Returned value: Credit Amount.

channel_ratestring

Channel Exchange Rate. Returned value: Channel Exchange Rate.

created_atstring

Created Time. Returned value: Created Time. The date or time format follows the value returned by the API.

success_timestring

Exchange Completion Time. Returned value: Exchange Completion Time. The date or time format follows the value returned by the API.

channel_statusstring

Channel Exchange Status. Returned value: Channel Exchange Status.

channel_status_valstring

Channel Exchange Status (raw value). Raw value of channel_status. The channel_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

origin_statusstring

Channel Original Status. Returned value: Channel Original Status.

origin_textstring

Channel Return Information. Returned value: Channel Return Information.

abnormal_statusstring

Exception Status. Returned value: Exception Status.

abnormal_status_valstring

Exception Status (raw value). Raw value of abnormal_status. The abnormal_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

abnormal_remarkstring

Manual Remarks. Returned value: Manual Remarks.

totalintegerrequired

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "180089",
        "forex_id": "1489583853",
        "channel_name": "IB",
        "serial_no": "",
        "forex_type": "FROM",
        "from_currency": "USD",
        "from_amount": "10.00",
        "to_currency": "HKD",
        "to_amount": "0.00",
        "channel_rate": "",
        "created_at": "1784051698",
        "success_time": "",
        "channel_status": "Failed",
        "channel_status_val": "FAILED",
        "origin_status": "",
        "origin_text": "",
        "abnormal_status": "",
        "abnormal_status_val": "",
        "abnormal_remark": ""
      }
    ],
    "total": 148
  }
}