Skip to content
Longport Whale
Auto Withdrawal Rules

Withdrawal Rules Export

Export the Withdrawal Rules 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_withdraw_package_rules/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_withdraw_package_rules.yaml (the query capability).

Child attributes
filters.idstring

Withdrawal Rule ID

filters.lb_bank_channel_idstring

Withdraw Channel. Values are dynamically queried from atm_lb_bank_channel_id_name (not fixed); fetch them live via GET /v1/datasets/refs/lb_bank_channels.

filters.package_typestring

Withdrawal Policy. Options: 1 = Real Time Payment Of Single Order; 2 = Manual Review Of Timed Packing; 3 = Manual Packing; 4 = Batch Auto

1234

filters.support_regionstring

Supported Bank Types. Values are dynamically queried from atm_cash_notice_region (not fixed); fetch them live via GET /v1/datasets/refs/cash_notice_bank_region.

filters.support_bank_idsstring

Supported Bank Name. Values are dynamically queried from atm_cash_notice_region_bank (not fixed); fetch them live via GET /v1/datasets/refs/cash_notice_region_bank_name.

filters.statusstring

Status. Options: 1 = Enabled; 2 = Disabled

12

filters.audit_statusstring

Audit Status. Options: 0 = Init; 1 = New pending review; 2 = Waiting Edit Review; 3 = Delete pending approval

0123

filters.original_limitstring

Original Limit. Options: 0 = Unrestricted; 1 = Restricted

01

filters.rule_codesstring

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

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