Skip to content
Longport WhaleLongport Whale
Transfer Announcement

Update Deposit/Withdraw Notice Status

Updates the status of a deposit/withdrawal (ATM) notice (for example, on-shelf or off-shelf).

Request parameters

  • Required: id (notice ID), action (operation action)
  • See the field descriptions for each field's format, allowed values, and business meaning.

Business notes

action specifies the status operation to perform on the target notice, directly controlling whether it is visible to customers.

Risk warning

This operation changes the state of a customer-facing deposit/withdrawal notice. Confirm the target notice and action before calling.

Result

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

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

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

idstringrequired

Notice ID associated with this request.

actionstringrequired

Type of operation to perform for this request.

Allowed values: 1 Not enabled, 2 Enabled

Values
1
Disable
2
Enable

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