Skip to content
Longport WhaleLongport Whale
Remarks template

Add Lookup

Create a deposit/withdrawal remark preset, used to add a reusable predefined remark.

Request parameters

  • Required: category (remark category), priority, value_cn (Simplified Chinese text), value_hk (Traditional Chinese text), value_en (English text)
  • See each field's definition for its format, value range, default behavior, and business meaning.

Business notes

priority is a positive integer in the range 1-999999. value_cn/value_hk/value_en are the remark text for each language, provided by the caller.

Result

On success the remark preset is created; see the 200 response definition for the returned content.

POSThttps://b-api.lbkrs.com/atm/add/lookup

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.add_lookup

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

Request body application/json

categorystringrequired

Remark category.

Values
setting_remark_deposit
Deposit
setting_remark_withdrawal
Withdrawal
setting_remark_securitiesdeposit
Securities Deposit
setting_remark_securitieswithdrawal
Securities Withdrawal
setting_remark_accountadjustment
Account Adjustment
setting_remark_withdrawal_reject
Withdrawal rejection
setting_remark_deposit_reject
Deposit rejection
setting_remark_withdrawal_card_reject
Refuse Add Bank Card
setting_remark_fund
Fund
setting_remark_otc_derivatives
OTC Derivatives
setting_remark_deposit_matching
Deposit Matching
prioritynumberrequired

A positive integer in the range 1–999999.

value_cnstringrequired

Simplified Chinese text of the predefined remark entry, entered by the caller. Required; up to 128 characters.

value_hkstringrequired

Traditional Chinese (Hong Kong) text of the predefined remark entry, entered by the caller. Required; up to 128 characters.

value_enstringrequired

English text of the predefined remark entry, entered by the caller. Required; up to 128 characters.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean
idstring
tipstring
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