Skip to content
Longport Whale
Transfer-Out Details

Transfer-Out Details Export

Export the Transfer-Out Details list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_transfer_out_stocks/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_transfer_out_stocks.yaml (the query capability).

Child attributes
filters.transfer_idstring

Request ID

filters.idstring

Transfer-Out Record ID

filters.is_realitystring

Physical Script. Options: 0 = 否; 1 = True

01

filters.statestring

Transfer-Out Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 0 = Initialize; 1 = Success; 2 = Fail; 3 = Deleted

0123

filters.created_atobject

Submit time. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
filters.created_at.gtestring

Greater Than or Equal

filters.created_at.ltestring

Less Than or Equal

filters.apply_statestring

Approval Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 0 = Init; 1 = Pending Success Review; 2 = Pending Fail Review; 3 = Pending Edit Review; 6 = Delete pending approval

01236

filters.member_idstring

Client ID

filters.marketstring

Market. Options: US = US; HK = HK; UK = UK; SH = SH; SZ = SZ; SG = SG; KR = KR; JP = JP; AU = AU; DE = DE; CA = CA; TH = TH; ID = ID; MY = MY; TR = TR; NA = NA; OSL = OSL; HAS = HAS; EU = EU; UT = UT; GTMMF = GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

filters.counter_idstring

Stock

filters.settled_atobject

Settled At. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
filters.settled_at.gtestring

Greater Than or Equal

filters.settled_at.ltestring

Less Than or Equal

filters.cheat_statestring

Risk Status. Options: 0 = Risk Control In Progress; 1 = Not Targeted; 2 = Targeted

012

filters.hit_rulesstring

Hit Rules. Values are dynamically queried from aml_transfer_out_rules (not fixed); fetch them live via GET /v1/datasets/refs/risk_rule_indicators_transfer_out.

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

Whale Docs