https://b-api.longbridge.xyz/v1/atm/out/cash/package/ruleAuthorization
Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.
Request body application/json
Whether the packaging rule is restricted to the original-limit withdrawal account dimension. Editable when creating; read-only when editing.
0 · Unrestricted1 · Restricted
Dropdown; the candidate list depends on original_limit and which site it is, drawing from different dynamic enums: when original_limit=1 and on certain sites, values come from withdraw_methods, otherwise from withdraw_company_bank_channels (the edit state uses the cascade enum withdraw_company_bank_channels_cascade).
Call GET /v1/datasets/refs/withdraw_methods to retrieve the current data dictionary, and use the returned entry's key as this field's value.
Packaging type for outbound cash payments.
1 · Real Time Payment Of Single Order2 · Manual Review Of Timed Packing3 · Manual Packing4 · Batch Auto
An integer in the range 0-100, converted to a string before submission.
Fee-bearing method for the outbound cash payment, following SWIFT charge conventions.
SHA · SHAOUR · OURBEN · BEN
Shown only when charge_type is SHA or OUR, a dropdown selection; candidates come from a dynamic query of company_bank_account_config after a bank channel is selected.
An addable-row list of [{currency, amount}]; currency's values come from the tenant_currencies_by_channel dynamic enumeration and amount is a number; serialized to a string before submission.
Call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary, and use the returned entry's key as this field's value.
The value is a sequence of indices into the single_quota_currency_amount array (e.g. [0,1,...]), used to indicate row order.
A comma-separated string of the deduplicated currency values from each row of single_quota_currency_amount; not an independent request field.
Multi-select; candidates come from the withdraw_rule_bank_regions dynamic enumeration, joined into a comma-separated string before submission; changing it re-queries the candidate banks for support_bank_ids in cascade.
Call GET /v1/datasets/refs/withdraw_rule_bank_regions to retrieve the current data dictionary, and use the returned entry's key as this field's value.
Multi-select; candidates come from the bank list returned by atm_region_banks_pick_exclude_default, queried in cascade with support_region.
Whether securities authorization is supported.
0 · Not Supported1 · Support
An integer in the range 0-999.
Single-select; values: '1' = enabled, '2' = disabled.
Allowed values:
1- Enable2- Disable
1 · Enable2 · Disable
Specifies Remark.
Shown only on certain sites; multi-select, values from the risk_rule_indicators_withdraw dynamic enum (includes all=All; selecting All mutually excludes and clears the other options).
Call GET /v1/datasets/refs/risk_rule_indicators_withdraw to retrieve the current data dictionary, and use the returned entry's key as this field's value.
Shown only on certain sites when original_limit='1'; multi-select accounts grouped by bank, with candidates from the dynamic query atm_lb_bank_accounts_package_rule.
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}.
Allowed values:
hk_trade_day- HK Trading Daycalendar_day- Calendar Dayweek- Week
hk_trade_day · HK Trading Daycalendar_day · Calendar Dayweek · Week
Same structure as service_time; a separate time-window configuration, as a JSON string.
Always sends 2 (for legacy-endpoint compatibility); not a visible field.
Not a direct request 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).
Not a request field; always sends 1 (shared by add/edit).
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 200The request was processed successfully. The response data does not contain additional business fields.codemessagedatadataobjectdata structureNo nested fields
HTTP 400Bad request. Check the business error code in code and the error details in message.codemessagedatadataobjectdata structureNo nested fields
HTTP 401The user is not authenticated, or the login session has expired.codemessagedatadataobjectdata structureNo nested fields
HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.codemessagedatadataobjectdata structureNo nested fields
HTTP 408The request timed out. Check the business error code in code and the error details in message.codemessagedatadataobjectdata structureNo nested fields