Exchange Order

Queries Exchange Order data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

Authorizationstringheaderlb_hk_conversion.userexchangebill_queryRequired

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

Query parameters

filtersobject

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

Child attributes

forex_idstring

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

client_ordidstring

Channel Exchange Order ID. Filters results by Channel Exchange Order ID.

member_idstring

Client ID. Filters results by Client ID.

forex_typestring

Exchange Type. Filters results by Exchange Type.

Allowed values: FROM, TO

FROMTO

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.

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.

audit_statusstring

Review Status. Filters results by Review Status.

Allowed values:

WAIT_AUDIT - Pending Review
REJECTED_AUDIT - Rejected
APPROVED_AUDIT - Reviewed

WAIT_AUDITREJECTED_AUDITAPPROVED_AUDIT

originstring

Requestor. Filters results by Requestor.

Allowed values:

0 - User
1 - Manual
2 - WAS
3 - Auto
4 - Force

01234

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 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

forex_idstring

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

client_ordidstring

Channel Exchange Order ID. Returned value: Channel Exchange Order ID.

member_idstring

Client ID. Returned value: Client ID.

member_id_valstring

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

origin_idstring

A/C No.. Returned value: A/C No..

forex_typestring

Exchange Type. Returned value: Exchange Type.

change_typestring

Exchange Type. Returned value: Exchange Type.

change_type_valstring

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

service_strategystring

Exchange Strategy. Returned value: Exchange Strategy.

service_strategy_valstring

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

from_currencystring

Debit Currency. Returned value: Debit Currency.

from_currency_valstring

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

from_amountstring

Debit Amount. Returned value: Debit Amount.

to_currencystring

Credit Currency. Returned value: Credit Currency.

to_currency_valstring

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

to_amountstring

Credit Amount. Returned value: Credit Amount.

ratestring

Client Exchange Rate. Returned value: Client Exchange Rate.

fx_currencystring

Conversion Currency. Returned value: Conversion Currency.

fx_amountstring

Conversion Amount. Returned value: Conversion Amount.

fx_ratestring

Conversion Exchange Rate. Returned value: Conversion Exchange Rate.

reference_ratestring

Reference Rate. Returned value: Reference Rate.

bid_ratestring

Bid Rate. Returned value: Bid Rate.

created_atstring

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

finish_timestring

Estimated Processing Time. Returned value: Estimated Processing 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.

forex_statusstring

Client Exchange Status. Returned value: Client Exchange Status.

forex_status_valstring

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

originstring

Requestor. Returned value: Requestor.

origin_valstring

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

audit_statusstring

Review Status. Returned value: Review Status.

audit_status_valstring

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

audit_remarkstring

Remark. Returned value: Remark.

audit_remark_valstring

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

order_remarkstring

Statement Remark. Returned value: Statement Remark.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "forex_id": "1284943380",
        "client_ordid": "",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "origin_id": "H00000000",
        "forex_type": "FROM",
        "change_type": "Large Amount Exchange",
        "change_type_val": "1",
        "service_strategy": "Pool exchange",
        "service_strategy_val": "BATCH",
        "from_currency": "HKD",
        "from_currency_val": "HKD",
        "from_amount": "800.00",
        "to_currency": "USD",
        "to_currency_val": "USD",
        "to_amount": "97.28(Estimate)",
        "rate": "--",
        "fx_currency": "",
        "fx_amount": "--",
        "fx_rate": "--",
        "reference_rate": "submit(After adding points):0.1216",
        "bid_rate": "",
        "created_at": "1784183837",
        "finish_time": "1784184301",
        "success_time": "0",
        "forex_status": "Submitted",
        "forex_status_val": "SUBMITTED",
        "origin": "Cash Plus Balance",
        "origin_val": "5",
        "audit_status": "Reviewed",
        "audit_status_val": "APPROVED_AUDIT",
        "audit_remark": "",
        "audit_remark_val": "",
        "order_remark": ""
      }
    ],
    "total": 233
  }
}