Skip to content
Longport Whale
Automatic Review Rules

Create Withdraw Audit Rule

Submitted by "Add" on the automatic-review-rule page, adding a withdrawal-amount auto-review rule. It changes real withdrawal auto-review rules.

POSThttps://b-api.longbridge.xyz/withdraw/audit/create

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

rule_namestringrequired

Rule Name. Rule name, a plain text input.

region_codesstringrequired

Bank Account Region Codes. Region, multi-select; values come from the atm_cash_notice_region dynamic enumeration (including all=All).

bank_idsstringrequired

Bank IDs. Bank; candidate banks are derived in cascade from the selected region (including 0 = All).

rule_codesstringrequired

Hit Rules (AML Withdraw Rules). Hit rules, multi-select; values come from the aml_finance_withdraw_rules dynamic enumeration (including all=All; selecting all is mutually exclusive with the other options).

currenciesstringrequired

Currencies. Currency, multi-select; values come from the global_currency_with_all dynamic enumeration (including ALL=All).

left_valuestringrequired

Amount Range Min. The lower bound of the amount range; on submit it is split, together with the upper bound, into left_value/right_value.

right_valuestringrequired

Amount Range Max. The upper bound of the amount range; must be no less than the lower bound.

prioritynumberrequired

Priority. Priority, a number 0-999; before submission it validates whether the same priority already exists under the same rule type.

remark_reasonstring

Remark Reason. Shown only when the review result is auto-reject; text, up to 500 characters, and can be chosen from predefined remarks.

remark_config_typestring

Remark Predefined Config Type. Indicates whether the rejection remark comes from a predefined template; attached automatically by the system based on whether a predefined remark was selected.

client_to_see_remarkboolean

Client Can See Reject Remark. Shown only when the review result is auto-reject; true = visible to the client / false = not visible.

hit_rulesstring

Hit Rules (reserved in interface). A field used only when displaying historical records; not submitted when adding a rule.

ticket_auditboolean

Ticket Audit. Shown only when the review result is manual review; true = yes / false = no. When manual review is chosen, it defaults to true.

audit_resultstringrequired

Audit Result. Review result; values come from the atm_withdraw_audits_result dynamic enumeration: 0 = auto-submit, 1 = manual review, 2 = auto-reject.

rule_codes_valstring

Hit Rules (comma-joined display value). A field used only for parsing the list display; not submitted when adding a rule.

rule_typestringrequired

Rule Type. Fixed to 'finance', marking this as a withdrawal-amount auto-review rule (distinct from other review-rule types).

rule_statusstringrequired

Rule Status. Rule status, single-select, initial value '1': 1 = enabled, 2 = disabled.

Responses

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

No nested fields

Whale Docs