Skip to content
Financing Audit

Edit Financing Pool

Edits the parameters of an existing IPO financing batch (financing pool).

Request parameters

  • Required: id (batch index), type (pool type), amount (financing amount), channel (financing channel), ratio (financing ratio), rate_id (rate ID), start_at (start timestamp), ended_at (end timestamp), currency
  • Also needed in practice: group (client group) and a non-empty rules list (subscription quantity rules, e.g. [{"min_qty":0,"max_qty":1000}]), otherwise the call fails with group rule empty; min_cash and threshold must be numeric strings (e.g. "0.00"), empty values fail with a format error
  • Optional: bank_ratio, financing_base_type, remark, audit_frontend_resource
  • See each field description for its format, value range, and business meaning.

Business notes

The target financing batch is located by id, and its financing limits, interest rate, and charging parameters are updated.

Risk warning

This operation changes the limits, interest rate, and charging rules of an IPO financing pool and directly affects customers' financed-subscription costs. Verify the target batch and parameters before calling.

Result

On success, returns the ID of the modified financing batch.

POSThttps://b-api.lbkrs.com/v2/ipo/margin/edit

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.financing_batch

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

Request body application/json

idintegerrequired

Batch ID. This field is required.

ended_atintegerrequired

Ended At.

start_atintegerrequired

Start At.

bank_ratiostring

Bank Ratio.

typestringrequired

Financing pool type, same values as type on ipo_margin_new (0 financing subscription, 3 zero-cost subscription), but sent as a string here (e.g. "0").

amountstringrequired

Financing amount, submitted as a string with two decimal places.

channelstringrequired

Financing channel identifier. Options come from a backend data dictionary.

rationumberrequired

Financing ratio as a percentage, 1–99; sent as a number here and as a string on ipo_margin_new. 100 is rejected on ipo_margin_new with 100% 融资请选择 0 成本类型: (ratio must less then 100); not tested here, so keep it below 100 as well; whether type 3 (zero-cost subscription) allows 100 is unverified.

rate_idstringrequired

Identifier of the associated interest-rate config. Options come from a backend data dictionary.

currencystringrequired

Currency, always submitted as HKD.

financing_base_typestring

Financing base type, sent only in certain scenarios. Options come from a backend data dictionary.

thresholdstring

Warning threshold amount, submitted as a string with two decimal places.

min_cashstring

Minimum cash requirement, submitted as a string with two decimal places.

rulesarray<object>

Subscription quantity rules; each item has min_qty and max_qty (lower and upper bound). Must not be empty.

Child attributes
min_qtyinteger

Lower quantity bound.

max_qtyinteger

Upper quantity bound.

groupstring

Client group. ALL means all clients (confirmed on TEST); other values are not documented.

remarkobject

Localized remark object with zh_cn, zh_hk, and en.

audit_frontend_resourceobject

Caller-provided audit context object.

Responses

HTTP 200The request was processed successfully. data.id is the ID of the modified financing batch.
Standard response envelopecodemessagedata
dataobjectdata structure
idinteger

Financing Batch ID.

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