Skip to content
Longport WhaleLongport Whale
Deposit Parameter

Toggle Deposit Config On/Off

Enables or disables group deposit parameter configurations in bulk; action selects enable or disable.

Request parameters

  • Required: ids (configuration ID list), action (operation type), audit_frontend_resource (caller-provided audit context)
  • See the field definitions for each field's format, value range, and business meaning.

Business notes

The same enable/disable action can be applied to multiple configurations at once. Once disabled, the affected deposit configuration no longer applies to customers.

Risk warning

This operation changes customer-facing deposit configuration and may affect the deposit channels and guides users can see. Confirm the target record and parameters before calling.

Result

On success the operation is completed; refer to the 200 response definition for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/v2/atm/group/deposit/config/on/off

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_depositconfig.depositconfig_group_on_off

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

Request body application/json

idsarray<string>required

Config ID List. Submit Config ID List as a JSON array. This field is required.

actionstringrequired

Action. Type of operation to perform for this request. This field is required.

audit_frontend_resourceobjectrequired

Audit Context. Provides audit context for this operation. This field is required.

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