Skip to content
Longport WhaleLongport Whale
HK IPO

Save IPO Subscription Payable

Adds or updates a payable (subscription) entry in the IPO subscription list.

Request parameters

  • Required: counter_id (security ID), apply_num_sub (share count), payable (amount)
  • Optional: id (subscription list item ID), group_id (group ID)
  • See each field description for its format, value range, and business meaning.

Business notes

When id is omitted, a new list item is created; when id is provided, the share count and payable amount of the matching item are updated.

Risk warning

This operation writes payable data used for IPO subscription deductions. Verify the security, share count, and amount before calling.

Result

On success, the subscription list item is saved; the returned data follows the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/ipo/payable/save

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.subscription_manage

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

Request body application/json

idinteger

Payable ID.

counter_idstringrequired

Counter ID. This field is required. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

apply_num_substringrequired

Shares. This field is required.

payablestringrequired

Payable Amount. This field is required.

group_idinteger

Group ID.

Responses

HTTP 200The request was processed successfully. data.result is true when the item is saved.
Standard response envelopecodemessagedata
dataobjectdata structure
resultboolean

Whether the request succeeded.

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