Skip to content
Longport Whale
Channel Exchange Order

Channel Exchange Order

Query the Channel Exchange Order list.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_forex_channel_orders

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes
filters.idstring

Channel Conversion Order No

filters.forex_idstring

Conversion Order No

filters.channel_namestring

Exchange Channel

filters.from_currencystring

Debit Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.to_currencystring

Credit Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.forex_typestring

Exchange Type. Options: FROM = FROM; TO = TO

FROMTO

filters.created_atobject

Created Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded). Defaults to the range [6 day(s) ago, today] when omitted (gte/lte roll with the request date).

Child attributes
filters.created_at.gtestring

Greater Than or Equal

filters.created_at.ltestring

Less Than or Equal

filters.success_timeobject

Exchange Completion Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
filters.success_time.gtestring

Greater Than or Equal

filters.success_time.ltestring

Less Than or Equal

filters.channel_statusstring

Channel Exchange Status. Options: SUBMITTED = Submitted; PENDING = Pending; APPROVED = Approved; FAILED = Failed; REJECTED = Rejected; CANCELED = Canceled

SUBMITTEDPENDINGAPPROVEDFAILEDREJECTEDCANCELED

filters.abnormal_statusstring

Exception Status. Options: UNPROCESSED = Unprocessed; WAIT_REVIEW = Pending Review; TURN_SUCCESS = Set as Successful; TURN_FAILURE = Set as Failed; TURN_RETRY = Re Exchange

UNPROCESSEDWAIT_REVIEWTURN_SUCCESSTURN_FAILURETURN_RETRY

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

totalintegerrequired

Total

Whale Docs