Skip to content
Private Fund Management

Add Private Fund

Create a new private fund.

Request parameters

  • No strictly required parameters; the private fund's data is carried mainly in params, with optional fields described below.
  • Common optional fields: dealing_setting (dealing settings), subscription_setting (subscription settings), file_id/file_ids (attachments), highlight_type/highlights (selling points), edit_share_unit_setting (share unit settings), audit_frontend_resource (audit context).
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

params carries the private fund's basic information, while dealing, subscription, and share-unit configurations are set via their respective fields.

Returns

On success returns the ID of the newly created private fund.

POSThttps://b-api.lbkrs.com/funds/admin/add-private-funds

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.pe_show_fund

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

Request body application/json

paramsobjectrequired

params

Child attributes
currencystring

Currency code, e.g. USD.

channel_namestring

Fund channel.

pcounter_idstring

Upstream internal code.

counter_id_pstring

Upstream internal code.

dealing_settingobject

dealing_setting

subscription_settingobject

subscription_setting

file_idsarray<string>

file_ids

highlight_typenumber

highlight_type

highlightsarray<object>
Child attributes
typenumber

highlights[].type

contentstring

highlights[].content

edit_share_unit_settingobject

edit_share_unit_setting

audit_frontend_resourceobject

audit_frontend_resource

Responses

HTTP 200The request was processed successfully. data.id is the ID of the newly created private fund.
Standard response envelopecodemessagedata
dataobjectdata structure
idinteger

Private Fund ID. ID of the newly created private fund.

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