Create Deposit/Withdrawal Notice

Creates a deposit/withdrawal notice, configuring its type, display channels, effective time, target scope, and multi-language title and content.

Request parameters

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

Result

On success, the notice is created. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/v1/portfolio/atm/notice

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

notice_typestringrequired

Notice type. This field is required.

Allowed values:

1 - Deposit
2 - Withdrawal

1 · Deposit2 · 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.

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.