Skip to content
Longport WhaleLongport Whale
Contract Amendments

Create Stock Exchange Contract Revise

Create a contract revision that corrects an existing customer contract by cancelling the original contract and reopening it with the revised parameters.

Request parameters

  • Required: old_contract_id (original contract ID), aaid (securities account), settlement_channel (settlement channel), trade_date (trade date)
  • Remaining fields are optional, including order source, trade stage, expected settlement dates, settlement sub-position, custodian, settlement currency, FX rate, fee and discount lines, and the post-migration instruction type, settle method, sub-position, and custodian.
  • See each field's description for format, value range, and business meaning.

Business notes

The original contract is cancelled, and the contract and its fees are re-created with the new parameters.

Risk warning

This operation may change real funds, positions, or trade status. Confirm the target record and parameters before calling.

Result

On success, the operation completes; the resulting state and returned data follow the 200 response definition.

PUThttps://b-api.lbkrs.com/billing/stock_exchange_contract/revise

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.contract_revise

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

Request body application/json

old_contract_idstringrequired

Old Contract ID associated with this request.

aaidstringrequired

Specifies A/C No.. This field is required.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

settlement_channelstringrequired

This field is required.

order_sourcestring
stagestring
expected_balance_settlement_datestring
expected_equity_settlement_datestring
settlement_accountstring
custodian_idstring
currency_setlstring
trade_to_setl_exchange_ratenumber
trade_datestringrequired

Trading date associated with this request. Use the date format defined by the API. This field is required.

billsarray<string>

Submit Bill List as a JSON array.

discountsarray<string>

Submit Discount List as a JSON array.

to_clearing_instr_typestring

to_clearing_instr_type.

Allowed values: A ATI, T STI, S SI, I ISI

Values
A
ATI
T
STI
S
SI
I
ISI
to_clearing_settle_methodstring

to_clearing_settle_method.

Allowed values: F FOP, D DVP, R RDP

Values
F
FOP
D
DVP
R
RDP
to_clearing_sub_position_nostring
to_clearing_custodian_idstring

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