Skip to content
Longport WhaleLongport Whale
Delivery Method Setting

Update Statement Notice Config

Edit the statement-delivery notification configuration of a given member.

Request parameters

  • Required: aaid (internal securities account ID), audit_frontend_resource (audit context)
  • Optional: daily_notice_app (daily app notification), monthly_notice_app (monthly app notification), daily_notice_email (daily email notification), monthly_notice_email (monthly email notification), online (offline delivery)
  • The admin console identifies the customer by aaid, not member_id, and sends every switch as the string 1 or -1.
  • See each field description for format, value range, and business meaning.

Business notes

The parameter structure matches statement notification creation; overwrites the existing notification switches of the securities account aaid.

Result

On success the notification configuration is updated; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/portfolio/statement/update_statement_notice

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.send_typeb2b_statement.send_type

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

Request body application/json

aaidstringrequired

Internal securities account ID of the customer. This field is required.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

daily_notice_appstring

Daily app notification.

Allowed values: 1 On, -1 Off

Values
1
On
-1
Off
monthly_notice_appstring

Monthly app notification.

Allowed values: 1 On, -1 Off

Values
1
On
-1
Off
daily_notice_emailstring

Daily email notification.

Allowed values: 1 On, -1 Off

Values
1
On
-1
Off
monthly_notice_emailstring

Monthly email notification.

Allowed values: 1 On, -1 Off

Values
1
On
-1
Off
onlinestring

Whether statements are delivered offline.

Allowed values: -1 Yes (send offline), 1 No (send online)

Values
-1
Yes (send offline)
1
No (send online)
audit_frontend_resourceobjectrequired

Audit context submitted by the caller. The admin console sends $action (edit) together with the configuration values before the change. 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