Create Deposit/Withdrawal Notice

Creates a deposit/withdrawal (ATM) notice, configuring its type, display channels, effective period, target scope, and multilingual title and content.

Request parameters

Required: notice_type (notice type), title (title), description (content).
title, description, and confirm_button_label are multilingual fields and must be passed as JSON strings keyed by language code.
account_channel, region_ids, and region_bank_ids are multi-value fields; join multiple values into a comma-separated string.
show_begin and show_end are Unix timestamps in seconds.
See the field descriptions for each field's format, allowed values, and business meaning.

Business notes

A deposit/withdrawal notice shows prompt information to a targeted set of customers in deposit/withdrawal scenarios. The display scope can be constrained by client channel, account channel, region, and regional bank, and ordering is controlled by priority.

Risk warning

This operation creates a customer-facing deposit/withdrawal notice. Confirm the display scope, effective period, and multilingual content before calling.

Result

On success the notice is created; subsequent status and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/portfolio/atm/notice

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_cash_in_out_notice.lb_hk_cash_in_out_notice_update

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

Request body application/json

notice_typestringrequired

Notice type. This field is required.

Allowed values: 1 Deposit, 2 Withdrawal

Values

1: Deposit
2: Withdrawal

titlestringrequired

Multi-language title passed as a JSON string keyed by language code such as zh-CN, zh-HK, and en. This field is required.

descriptionstringrequired

Multi-language notice content passed as a JSON string. This field is required.

client_channelobject

Display channel configuration. A map from channel keys to booleans indicating whether the notice shows on that channel. Version-gated channels additionally carry <channel>_low and <channel>_up fields for the effective version range.

Child attributes

appboolean

Whether the notice shows on the app channel.

account_channelstring

Account channels the notice applies to. Multiple values are passed as a comma-separated string.

org_idsarray<string>

Target organization ID list. When omitted or empty, the notice applies to all available organizations by default.

app_idsarray<string>

List of apps the notice reaches.

region_idsstring

Bank account regions. Multiple values are passed as a comma-separated string.

region_bank_idsstring

Bank names (bank IDs). Multiple values are passed as a comma-separated string.

bank_operation_types_idstring

Deposit method.

remarkstring

Remarks.

show_begininteger

Time when the notice starts showing, as a Unix timestamp in seconds.

show_endinteger

Time when the notice stops showing, as a Unix timestamp in seconds.

linkstring

Redirect link opened when the notice is clicked.

client_display_waystring

How the notice is displayed on the client.

confirm_button_labelstring

Multi-language confirm button copy passed as a JSON string. Optional.

priorityinteger

Notice priority; a larger value means higher priority.

Responses

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