Skip to content
Crypto Approval

Add Withdraw Audit Rule

Creates a virtual-asset withdrawal (crypto) audit rule.

Request parameters

  • Required: rule_name (rule name), priority, upstream_broker (channel), account_nos (applicable accounts), broker_allocate_states (broker fund-allocation states), coin_quantity_list (coin and quantity-range list), delay_time (audit delay), audit_type (audit rule), and status.
  • Optional: equivalent_usd (USD-equivalent amount range) and remark.
  • Set account_nos to all for all accounts, or a comma-separated list of securities accounts; delay_time is in minutes, range 1-999.
  • See the field descriptions for each field's format, range, and business meaning.

Business notes

When a withdrawal request matches the rule, audit_type and delay_time determine the audit method and delay.

Risk warning

This operation creates a real withdrawal audit rule that directly affects the release and review flow for virtual-asset withdrawals. Confirm the rule conditions and status before calling.

Result

On success the withdrawal audit rule is created; subsequent state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/atm/va/add/withdraw/audit/rule

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.crypto_approval_operation

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

rule_namestringrequired

This field is required.

prioritynumberrequired

Processing priority. Interpret the value and sort order according to the allowed-value definitions. This field is required.

upstream_brokerstringrequired

Distinguishes the upstream party for the deposit account; the only client option is currently HASHKEY.

Allowed values: HASHKEY

Values
HASHKEY
HASHKEY
account_nosstringrequired

For "All Accounts" pass all; for "Specified Accounts" pass multiple securities account numbers separated by commas.

broker_allocate_statesstringrequired

Broker-allocation statuses. Select multiple values and join them with a comma , when submitting.

Allowed values: 4 Success, 5 Failed, 6 Abnormal, 7 Rejected

Values
4
Success
5
Failed
6
Abnormal
7
Rejected
coin_quantity_listarray<object>required

A dynamic list where each item is { coin: currency (values come from the tenant_crypto_currencies dynamic enum), quantity_min: minimum quantity, quantity_max: maximum quantity }.

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

Child attributes
coinstring

Coin code.

quantity_minstring

Minimum quantity (numeric string).

quantity_maxstring

Maximum quantity (numeric string).

equivalent_usdobject

{ amount_min, amount_max }, an optional numeric range.

Child attributes
amount_minstring

Minimum USD-equivalent amount (numeric string).

amount_maxstring

Maximum USD-equivalent amount (numeric string).

delay_timenumberrequired

In minutes; value range 1–999.

audit_typestringrequired

Audit type.

Values
auto_pass
Auto Approved
auto_reject
Auto Rejected
manual_ticket
Ticket Approval
statusstringrequired

enabled - Enabled, disabled - Disabled

remarkstring

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean
idstring
tipstring
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