Transfer In

Query the list of securities transfer-in (rollover) requests, i.e. records of clients transferring securities holdings into the platform from another broker.

Request parameters

Combine business filters through filters (see the filter-field notes below for the available fields), and use page, page_size, and orderBy for pagination and sorting.

Business notes

Each record is one transfer-in request, carrying the request ID, origin, client ID and region, securities account, client name, support manager, and other client details.
It also records the transfer-from broker, transfer status, order status, back-office status, broker-notification status, remarks, processing days, and the submission and update times.
Filter by client, request ID, securities account, stock, transfer broker, stock market, origin, or creation time; batch lookup by client ID or securities account is supported, helping operations track the progress of transfer-in requests.

Returns

On success, returns the list of matching records with pagination. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

finance.rollover

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

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

member_idstring

Client. Filters results by Client.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

idstring

Transfer-in Request ID. Filters results by Transfer-in Request ID.

origin_idstring

A/C No.. Filters results by A/C No..

stock_namestring

Stocks. Filters results by Stocks.

stock_amountstring

Quantity. Filters results by Quantity.

brokerstring

Broker. Filters results by Broker.

created_atobject

Created Time. Filters results by Created Time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

batch_member_idstring

Bulk Search For Client No.. Filters results by Bulk Search For Client No..

batch_origin_idstring

Bulk Search Account No.. Filters results by Bulk Search Account No..

marketstring

Market. Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

Values

US
HK
UK
SH
SZ
SG
KR
JP
AU
DE
CA
TH
ID
MY
TR
NA
OSL
HAS
EU
UT
GTMMF

originstring

Origin. Filters results by Origin.

Allowed values: 0 User, 1 Operator, 2 WAS

Values

0: User
1: Operator
2: WAS

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Transfer In records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Transfer-in Request ID. Returned value: Unique identifier of the current record.

id_valstring

Transfer-in Request ID (raw value). Raw value of id. The id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

originstring

Origin. Returned value: Origin.

origin_valstring

Origin (raw value). Raw value of origin. The origin field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

member_idstring

Client ID. Returned value: Client ID.

member_id_valstring

Client ID (raw value). Raw value of member_id. The member_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

member_regionstring

Client Region. Returned value: Client Region.

member_region_valstring

Client Region (raw value). Raw value of member_region. The member_region field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

origin_idstring

A/C No.. Returned value: A/C No..

real_namestring

Name. Returned value: Name.

support_manager_namestring

Support Manager. Returned value: Support Manager.

broker_idstring

Transfer From. Returned value: Transfer From.

broker_id_valstring

Transfer From (raw value). Raw value of broker_id. The broker_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

order_statestring

OrderState. Returned value: OrderState.

order_state_valstring

OrderState (raw value). Raw value of order_state. The order_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

app_statestring

Notify securities. Returned value: Notify securities.

app_state_valstring

Notify securities (raw value). Raw value of app_state. The app_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_remarkstring

Remark. Returned value: Remark.

days_to_updatedstring

Process Day. Returned value: Process Day.

app_task_idstring

App Task ID. Returned value: App Task ID.

user_email_idstring

Email Task ID. Returned value: Email Task ID.

created_atstring

Created at. Returned value: Created at. The date or time format follows the value returned by the API.

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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/atm_rollovers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "10511191255619",
        "id_val": "",
        "origin": "Client",
        "origin_val": "0",
        "member_id": "101456715",
        "member_id_val": "",
        "member_region": "China Mainland",
        "member_region_val": "CN",
        "origin_id": "H00000000",
        "real_name": "Zhang San",
        "support_manager_name": "--",
        "broker_id": " BOCI Securities Limited",
        "broker_id_val": "1",
        "order_state": "Canceled",
        "order_state_val": "8",
        "app_state": "Informed",
        "app_state_val": "1",
        "custom_remark": "",
        "days_to_updated": "0",
        "app_task_id": "628343072140337712",
        "user_email_id": "user@example.com",
        "created_at": "1784051256",
        "updated_at": "1784051275"
      }
    ],
    "total": 290
  }
}