Insert Bond Info

Create bond information and its interest-rate details for a given instrument.

Request parameters

Required: counter_id (instrument code), bond_info (bond information object), bond_rates (rate list)
Optional: audit_frontend_resource (caller-provided audit context)
See each field description for format, value range, and business meaning.

Business notes

bond_info is a JSON object and bond_rates is a JSON array of objects; one call registers the bond's basic information and its rate schedule.

Result

On success the bond information and rates are created; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/clearing/insert_bond_info

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_edit

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

Request body application/json

counter_idstringrequired

Counter ID associated with this request. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

bond_infoobjectrequired

Bond information object. This field is required.

Child attributes

period_completestringrequired

Period complete. This field is required. When 1, the rate of the last bond_rates item is left empty.

Call GET /v1/datasets/refs/clear_period_complete to retrieve the current data dictionary, and use the returned entry's key as this field's value.

interest_calc_basisstringrequired

Annual days used for interest calculation, such as 365. This field is required.

Call GET /v1/datasets/refs/clear_interest_calc_basis to retrieve the current data dictionary, and use the returned entry's key as this field's value.

par_valuenumberrequired

Par value, from 0 to 99999 with up to 2 decimal places, such as 100. This field is required.

cutoff_methodstringrequired

Rounding method. This field is required.

Call GET /v1/datasets/refs/billing_cutoff_method to retrieve the current data dictionary, and use the returned entry's key as this field's value.

cutoff_digitsstringrequired

Rounding decimal places. This field is required.

Call GET /v1/datasets/refs/billing_cutoff_digit to retrieve the current data dictionary, and use the returned entry's key as this field's value.

bond_ratesarray<object>required

Rate schedule. Submit at least 2 items, ordered by period. This field is required.

Child attributes

periodintegerrequired

Period number, starting from 0.

interest_payment_datestringrequired

Interest payment date in YYYYMMDD format. Each date must be later than the previous item's date.

ratestring

Rate as a decimal fraction, for example 0.05 for 5%. Required for the first item; leave empty for the last item when period_complete is 1.

audit_frontend_resourceobject

Audit context submitted by the caller, such as $behavior and $action (add or edit).

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.