Skip to content
Channel Setup

Manage IPO Rich Channel

Create or edit an IPO fund channel. The create, edit, and the embedded entry when creating a financing pool share the same request structure. It involves configuration changes.

Request parameters

  • Required: name (Channel Name), typo (Supported Types), to_fini (Sync to HKEx)
  • Optional: id (Channel ID), remark (Remark), alias (Channel Alias), audit_frontend_resource (Audit Context)
  • 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/ipo/richchannel/manage

Authorization

AuthorizationstringheaderRequired

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

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.

Allowed values:

  • CASH - Cash
  • FINANCING - Financing
  • ZEROCASH - 0 Cost
  • PLACEMENT - Placement

CASH · CashFINANCING · FinancingZEROCASH · 0 CostPLACEMENT · Placement

to_finistringrequired

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

Allowed values:

  • true - Yes
  • false - No

true · Yesfalse · No

remarkstring

Specifies Remark.

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

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