Skip to content
Longport Whale
eDDA

EDDA Export

Export the EDDA 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_edda_applications/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_edda_applications.yaml (the query capability).

Child attributes
filters.idstring

ID

filters.member_idstring

Member ID

filters.mandate_identificationstring

Authorization No

filters.user_bank_card_nostring

Client Bank Account No

filters.lb_bank_account_namestring

Beneficiary Bank Name. Values are dynamically queried from atm-bank-accounts-name-list (not fixed); fetch them live via GET /v1/datasets/refs/lb_bank_accounts_with_names.

filters.created_atobject

Created At. 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.statestring

Status. Options: 0 = Pending Review; 1 = Activating; 2 = Activated; 3 = Denied; 4 = Closed; 5 = Expired; 8 = Canceled

0123458

filters.verify_statestring

Manual Confirmation. Options: 0 = Processing not required; 1 = Pending Processing; 3 = Confirmed; 4 = Expired

0134

filters.bank_codestring

Bank Code

filters.referencestring

Reference No

filters.currencystring

Auth Currency. Options: HKD = HKD; CNH = CNH

HKDCNH

filters.auth_typestring

Authorization Type. Options: 0 = Unmatched; 1 = App Direct Initiation; 2 = Initiated Via Online Banking; 3 = Initiated Via Bank Counter

0123

filters.bank_sec_fail_reasonstring

Error/Exception Remarks

filters.updated_atobject

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

Child attributes
filters.updated_at.gtestring

Greater Than or Equal

filters.updated_at.ltestring

Less Than or Equal

filters.app_showstring

Display to Client. Options: 0 = 否; 1 = True

01

filters.busi_typestring

Approval Status. Options: 0 = Initial; 45 = Activate Pending; 49 = Deactivate Pending; 37 = Pending Review; 36 = Delete To Approve

045493736

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