Skip to content
Longport WhaleLongport Whale
Channel Setup

Manage IPO Rich Channel

Creates or edits an IPO funding channel; create, edit, and the embedded financing-pool creation entry share the same request structure.

Request parameters

  • Required: name (channel name), typo (supported business types), to_fini (whether to sync to HKEx).
  • Optional: id (channel ID, passed when editing), remark, alias, audit_frontend_resource (audit context).
  • See the field definitions for format, value ranges, defaults, and business meaning.

Business notes

Omitting id creates a new channel; passing an existing id edits it. name cannot be changed when editing.

Risk warning

This operation changes real IPO funding-channel configuration and may affect fund handling for IPO subscriptions. Confirm the target record and parameters before calling.

Result

On success the IPO funding channel is created or updated. Refer to the 200 response definition for returned data.

POSThttps://b-api.lbkrs.com/ipo/richchannel/manage

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.richchannel_manage

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

Request body application/json

idstring

Pass the existing record id when editing; not sent when creating.

namestringrequired

Up to 10 characters, letters/digits/underscores only; not editable in edit mode.

typostringrequired

Multi-select; enum values CASH (cash) / FINANCING (financing) / ZEROCASH (zero-cash) / PLACEMENT (placement); PLACEMENT is available only at certain entry points, while others have only the first three.

Values
CASH
Cash
FINANCING
Financing
ZEROCASH
0 Cost
PLACEMENT
Placement
to_finistringrequired

Enum value "true"/"false" (string), indicating whether to sync to HKEX.

Values
true
Yes
false
No
remarkstring
aliasstring

Channel alias (a reserved field; not collected by any current entry form and may be omitted).

audit_frontend_resourceobject

Records a snapshot of the channel data before and after the change and the operation type ($action: add/edit), used for backend audit trails.

Responses

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