Add Deposit Filter Rule

Add a deposit filter (blocking) rule; deposit bills matching the rule are blocked automatically.

This endpoint has no required parameters; see the optional fields below.
Optional: payer_bank_account (payer bank account), payer_name (payer name), currency (currency), lb_bank_account (Longbridge receiving bank account), business_type (business type), bank_remark (bank remark), bank_ret_msg (bank return message), audit_frontend_resource (audit context)
See the field definitions for each field's format, allowed values, and business meaning.

Rule fields match incoming deposits; matched deposits are blocked, so ensure the conditions are accurate.

On success the operation completes; refer to the 200 response for the resulting state and data.

POSThttps://b-api.lbkrs.com/atm/deposit/filter/rule

Authorization

AuthorizationstringheaderRequired

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

lb_hk_depositfilterrule.depositfilterrule_update

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

payer_bank_accountstring

Payer Bank Account. Whether it is required depends on the payer_bank_account_switch toggle.

payer_namestring

Payer Name. Whether it is required depends on the payer_name_switch toggle.

currencystring

Currency. Whether it is required depends on the currency_switch toggle; the dropdown enum comes from ref global_currency_filter_by_account_channel.

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.

lb_bank_accountstring

Bank Account. Whether it is required depends on the lb_bank_account_switch toggle.

business_typestring

Business Type. Whether it is required depends on the business_type_switch toggle; the dropdown enum comes from ref atm_bank_business_type.

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

bank_remarkstring

Bank Remark. Whether it is required depends on the bank_remark_switch toggle.

bank_ret_msgstring

Bank Return Message. An optional field; the client sets no required validation.

audit_frontend_resourceobject

Audit Context. Audit information automatically attached by the client, containing $behavior and $action='add'.

HTTP 200The request was processed successfully. The response data does not contain additional business fields.