corporate stock register detail events

Returns the execution schemes tied to a customer registration detail by its ID, used to view a single customer's actual share transfer-in/transfer-out results in a corporate action.

Request parameters

Combine business filters through filters (see the filters field reference below), and use page, page_size, and orderBy for pagination and sorting.
Provide the registration-detail ID register_id to target the detail; results are returned in descending order of scheme number.

Business notes

Data represents the executed schemes under one customer registration detail, one record per executed scheme.
Each record includes the scheme number, execution currency, the transfer-out security and quantity, the transfer-in security and quantity, the transfer-in amount, and remarks.
Typically used to verify a single customer's actual distribution or share-conversion execution result in a corporate action, or for customer enquiries and error investigation.

Returns

On success, returns the matching record list and pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_stock_register_detail_events

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

filtersobject

Filters

Child attributes

register_idstring

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

event_idstring

Event ID

currencystring

Currency

amount_payablestring

Credit Amount

origin_counter_idstring

Counter ID (Debit)

recycle_stock_payablestring

Debit Quantity

new_counter_idstring

Counter ID (Credit)

stock_payablestring

Credit Qty

remarkstring

Remarks

totalintegerrequired

Total

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/corp_action_stock_register_detail_events' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "event_id": "1000000001",
        "currency": "USD",
        "amount_payable": "125630.50",
        "origin_counter_id": "1000000001",
        "recycle_stock_payable": "string",
        "new_counter_id": "1000000001",
        "stock_payable": "string",
        "remark": "审核通过"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_stock_register_detail_events/download

lb_hk_corporate.corporate_query

Export options Export records Download result