Channel Exchange Order Export

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of atm_forex_channel_orders.yaml (the query capability).

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

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.

Standard response envelopecodemessagedata

dataobjectdata structure

urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_forex_channel_orders/download' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "orderBy": [],
  "mode": 0,
  "ext": "csv",
  "file_name": "",
  "remark": "",
  "down_fields": [],
  "ticket_content": "",
  "ticket_preview_url": "",
  "hide": 0
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "url": "<string>",
    "file_download_id": "<string>",
    "ticket_id": "<string>"
  }
}