Skip to content
Remarks template

Add Lookup

Creates a predefined remark. Fields include category, value_cn, value_hk, value_en, priority, and id; id is used only when editing. This operation changes live business configuration.

Request parameters

  • Required: category (Remark Category), priority (Priority), value_cn (Remark Content (zh-CN)), value_hk (Remark Content (zh-HK)), value_en (Remark Content (en))
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.longbridge.xyz/atm/add/lookup

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

categorystringrequired

Values are provided by the dynamic atm_remark_category enumeration and may vary.

Allowed 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

setting_remark_deposit · Depositsetting_remark_withdrawal · Withdrawalsetting_remark_securitiesdeposit · Securities Depositsetting_remark_securitieswithdrawal · Securities Withdrawalsetting_remark_accountadjustment · Account Adjustmentsetting_remark_withdrawal_reject · Withdrawal rejectionsetting_remark_deposit_reject · Deposit rejectionsetting_remark_withdrawal_card_reject · Refuse Add Bank Cardsetting_remark_fund · Fundsetting_remark_otc_derivatives · OTC Derivativessetting_remark_deposit_matching · Deposit Matching

prioritynumberrequired

A positive integer in the range 1–999999.

value_cnstringrequired

From the locales-textarea request field, locales['zh-CN']; up to 500 characters under the withdrawal-reject / deposit-reject categories, and up to 128 for other categories.

value_hkstringrequired

From the locales-textarea form item, locales['zh-HK'].

value_enstringrequired

From the locales-textarea form item, locales['en'].

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