Skip to content
Longport Whale
Bank Statement

Bank Statement Export

Export the Bank Statement 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/booking_bank_bills/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes
filters.idstring

Bank Statement ID

filters.order_idstring

Order ID

filters.bank_serial_nostring

Online Bank Serial No

filters.atm_bill_idstring

Withdrawal/Deposit Statement ID

filters.bank_accountstring

Bank Account of Payer

filters.bank_user_namestring

Name of Payer

filters.statestring

Marking State. Options: 1 = Unprocess; 2 = Pending Audit

12

filters.fund_type_idstring

Fund Type. Values are dynamically queried from pg_fund_types (not fixed); fetch them live via GET /v1/datasets/refs/fund_business_type.

filters.currencystring

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

Fund Flow. Options: 1 = In; 2 = Out

12

filters.bill_dateobject

Accounting Date (Bank). 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.bill_date.gtestring

Greater Than or Equal

filters.bill_date.ltestring

Less Than or Equal

filters.rms_dateobject

Accounting Date (Asset Middle Office). Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
filters.rms_date.gtestring

Greater Than or Equal

filters.rms_date.ltestring

Less Than or Equal

filters.keystring

Deposit Status. Options: 3 = Match; 4 = Counter Deal; 5 = Load Completed; 8 = Failed; 9 = Deleted; 100 = Pending Release; 200 = Pending Release Review; 6 = Rejected

345891002006

filters.match_statestring

Match Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 1 = Matched; 2 = Unmatch; 4 = Manually Match; 5 = Pending Transfer Audit; 6 = Frozen

12456

filters.bank_remarkstring

Bank Remark

filters.amountobject

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

Child attributes
filters.amount.gtenumber

Greater Than or Equal

filters.amount.ltenumber

Less Than or Equal

filters.lb_channelstring

All Banks

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