Skip to content
Longport Whale
Auto Withdrawal Rules

Add Out Cash Package Rule

Add an automatic withdrawal rule. It configures real automatic-withdrawal rules.

POSThttps://b-api.longbridge.xyz/v1/atm/out/cash/package/rule

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

original_limitstringrequired

Original Limit Type. A single-select shown only on the LBHK site; values come from the atm_out_package_original_limit dynamic enumeration (e.g. whether to use the "original-limit withdrawal account" dimension). Editable when creating, disabled in edit mode.

lb_bank_channel_idstringrequired

Bank Channel ID. A dropdown selection whose candidates come from different dynamic enumerations depending on original_limit and whether it is LBHK: when original_limit=1 and LBHK, values come from atm_bank_operate_types_original; otherwise from atm_select_lb_bank_channel_id_name (edit mode uses the cascading enumeration atm_select_lb_bank_channel_id_name_cascade).

package_typestringrequired

Package Type. A dropdown selection; values come from the atm_package_type dynamic enumeration.

batch_max_countstringrequired

Batch Max Count. An integer in the range 0-100, converted to a string before submission.

charge_typestringrequired

Charge Type. A dropdown selection; values come from the atm_charge_type dynamic enumeration, e.g. SHA/OUR/BEN and other SWIFT fee-bearing methods.

fee_bank_account_idstring

Fee Bank Account ID. Shown only when charge_type is SHA or OUR, a dropdown selection; candidates come from a dynamic query of lb_bank_accounts after a bank channel is selected.

single_quota_currency_amountstringrequired

Single Quota Currency Amount. An addable-row list of [{currency, amount}]; currency's values come from the global_currency_filter_by_account_channel dynamic enumeration and amount is a number; serialized to a string before submission.

single_quota_currency_amount_keysstringrequired

Single Quota Currency Amount Row Keys. The value is a sequence of indices into the single_quota_currency_amount array (e.g. [0,1,...]), used to indicate row order.

currencystringrequired

Currency (comma-joined). A comma-separated string of the deduplicated currency values from each row of single_quota_currency_amount; not an independent form field.

support_regionstringrequired

Support Region (comma-joined). Multi-select; candidates come from the atm_out_cash_rule_region dynamic enumeration, joined into a comma-separated string before submission; changing it re-queries the candidate banks for support_bank_ids in cascade.

support_bank_idsstringrequired

Support Bank IDs. Multi-select; candidates come from the bank list returned by atm_region_banks_pick_exclude_default, queried in cascade with support_region.

sec_authstringrequired

Secondary Auth Method. Single-select; values come from the atm_sec_auth dynamic enumeration.

prioritynumberrequired

Priority. An integer in the range 0-999.

statusstring

Rule Status. Single-select; values: '1' = enabled, '2' = disabled.

remarkstring

Remark. Free text.

rule_codesstring

Hit AML Withdraw Rules (LBHK only). Shown only on the LBHK site, multi-select; values come from the aml_withdraw_rules dynamic enumeration (including all=All; selecting all is mutually exclusive and clears the other options).

original_limit_bank_accountsstring

Original Limit Bank Accounts (LBHK & original_limit=1 only). Shown only on the LBHK site when original_limit='1'; accounts are multi-selected grouped by bank, with candidates from the dynamic query atm_lb_bank_accounts_package_rule.

service_timestringrequired

Service Time. A JSON string assembled from time_zones (enum: hk_trade_day/calendar_day/week) + time_rule; when time_zones='week', time_rule is multiple groups of {week_interval, time_interval}.

lb_service_timestringrequired

LB Service Time. Same structure as service_time; a separate time-window configuration, as a JSON string.

versionnumberrequired

Version Flag. Always sends 2 (for legacy-endpoint compatibility); not a visible field.

namestring

Bank Channel Name (denormalized). Not a direct form field; before submission the name is taken from the candidate corresponding to lb_bank_channel_id and submitted along with it (only present when a match is found).

action_innumberrequired

Action In Flag. Not a form field; always sends 1 (shared by add/edit).

audit_frontend_resourceobject

Frontend Audit Log Metadata. Not a business field; used for backend audit-log display. In the create scenario the front end always sends { before_id: the source rule ID carried in from the "Copy" entry (may be empty), showCopy: whether it is a copy-create }.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs