Skip to content
Auto Withdrawal Rules

Add Out Cash Package Rule

Add Out Cash Package Rule.

Request parameters

  • Required: original_limit (Original Limit Type), lb_bank_channel_id (Bank Channel ID), package_type (Package Type), batch_max_count (Batch Max Count), charge_type (Charge Type), single_quota_currency_amount (Single Quota Currency Amount), single_quota_currency_amount_keys (Single Quota Currency Amount Row Keys), currency (Currency (comma-joined)), support_region (Support Region (comma-joined)), support_bank_ids (Support Bank IDs), sec_auth (Secondary Auth Method), priority (Priority), service_time (Service Time), lb_service_time (Service Time), version (Version Flag), action_in (Action In Flag)
  • Optional: fee_bank_account_id (Fee Bank Account ID), status (Rule Status), remark (Remark), rule_codes (Hit AML Withdraw Rules (certain sites only)), original_limit_bank_accounts (Original Limit Bank Accounts (certain sites & original_limit=1 only)), name (Bank Channel Name (denormalized)), audit_frontend_resource (Frontend Audit Log Metadata)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

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

A single-select option shown only on certain sites; values come from the atm_out_package_original_limit dynamic enum (e.g. whether to use the 'original-limit withdrawal account' dimension). Editable when creating; disabled in edit state.

Allowed values:

  • 0 - Unrestricted
  • 1 - Restricted

Call GET /v1/datasets/refs/atm_out_package_original_limit to retrieve the current data dictionary, and use the returned entry's key as this field's value.

0 · Unrestricted1 · Restricted

lb_bank_channel_idstringrequired

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.

package_typestringrequired

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

Allowed values:

  • 1 - Real Time Payment Of Single Order
  • 2 - Manual Review Of Timed Packing
  • 3 - Manual Packing
  • 4 - Batch Auto

Call GET /v1/datasets/refs/atm_package_type to retrieve the current data dictionary, and use the returned entry's key as this field's value.

1 · Real Time Payment Of Single Order2 · Manual Review Of Timed Packing3 · Manual Packing4 · Batch Auto

batch_max_countstringrequired

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

charge_typestringrequired

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

Allowed values: SHA, OUR, BEN

Call GET /v1/datasets/refs/atm_charge_type to retrieve the current data dictionary, and use the returned entry's key as this field's value.

SHA · SHAOUR · OURBEN · BEN

fee_bank_account_idstring

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.

single_quota_currency_amountstringrequired

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.

single_quota_currency_amount_keysstringrequired

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

currencystringrequired

A comma-separated string of the deduplicated currency values from each row of single_quota_currency_amount; not an independent request field.

support_regionstringrequired

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.

support_bank_idsstringrequired

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

sec_authstringrequired

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

Allowed values:

  • 0 - Not Supported
  • 1 - Support

Call GET /v1/datasets/refs/atm_sec_auth to retrieve the current data dictionary, and use the returned entry's key as this field's value.

0 · Not Supported1 · Support

prioritynumberrequired

An integer in the range 0-999.

statusstring

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

Allowed values:

  • 1 - Enable
  • 2 - Disable

1 · Enable2 · Disable

remarkstring

Specifies Remark.

rule_codesstring

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.

original_limit_bank_accountsstring

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.

service_timestringrequired

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 Day
  • calendar_day - Calendar Day
  • week - Week

hk_trade_day · HK Trading Daycalendar_day · Calendar Dayweek · Week

lb_service_timestringrequired

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

versionnumberrequired

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

namestring

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

action_innumberrequired

Not a request field; always sends 1 (shared by add/edit).

audit_frontend_resourceobject

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.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs