Skip to content
Longport WhaleLongport Whale
Account Attributes

Add Account Attribute

Create a new Account Attribute configuration.

Request parameters

  • Required: name (attribute name), direct (balance side), and prefix_code (level-1 account code serial number).
  • See each field for its format, allowed values, and business meaning.

Result

On success, a new Account Attribute record is created. See the 200 response schema for returned data.

POSThttps://b-api.lbkrs.com/book/feature/add

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_book.book_features_modify

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

Request body application/json

namestringrequired

Account attribute name.

directstringrequired

Balance side.

1 · Debit2 · Credit3 · Common

prefix_codestringrequired

Level-1 account code serial number.

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