Skip to content
Longport WhaleLongport Whale
Adjustment

Account Cash Balance Adjustment

Performs a manual cash adjustment on a securities account, increasing or decreasing available funds by direction.

Request parameters

  • Required: account_no (securities account), direction (adjustment direction), currency, amount, biz_code (business code).
  • Optional: remark, request_id (idempotency key), require_risk_check (whether to run risk control).
  • biz_code values come from the business-code dictionary.
  • See the field descriptions for each field's format, value range, and business meaning.

Business notes

Credits or debits the account's cash according to direction, returning a transaction serial number serial_num on success. Use require_risk_check to toggle risk control and request_id to guarantee idempotency and prevent duplicate adjustments.

Risk warning

This operation directly changes real account funds. Confirm the account, direction, currency, and amount before calling.

Result

On success, the cash adjustment completes and returns serial_num. Refer to the 200 response definition for the resulting state.

POSThttps://b-api.lbkrs.com/v2/whaleapi/asset/adjust_cash

Authorization

AuthorizationstringheaderRequired

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

Permission

change_ticket.update

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

Request body application/json

account_nostringrequired

Account NO Eg:L6VQEU00121996. Account NO Eg:L6VQEU00121996

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

directionnumberrequired

Adjust Direction. Adjust Direction

currencystringrequired

Currency. Currency

amountstringrequired

Adjust Amount. Adjust Amount

biz_codestringrequired

Business Code. Business Code

remarkstring

Adjust Remark. Adjust Remark

serial_numstring

Serial Num. Serial Num

request_idstring

Idempotency ID ,keep Global Unique. Idempotency ID ,keep Global Unique

require_risk_checkboolean

Need Risk Check. Need Risk Check

Responses

HTTP 200Successful response
Standard response envelopecodemessagedata
dataobjectdata structure
msgstringrequired

Message. Message

serial_numstringrequired

Serial Number. Serial Number

error_codestringrequired

Error Code. Error Code

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