Skip to content
Bill Rules

Add Deposit Filter Rule

Add Deposit Filter Rule.

Request parameters

  • Optional: payer_bank_account (Payer Bank Account), payer_name (Payer Name), currency (Currency), lb_bank_account (Bank Account), business_type (Business Type), bank_remark (Bank Remark), bank_ret_msg (Bank Return Message), audit_frontend_resource (Audit Context)
  • 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/atm/deposit/filter/rule

Authorization

Authorizationstringheaderlb_hk_depositfilterrule.depositfilterrule_updateRequired

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

Request body application/json

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

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