Skip to content
Stock Transfer In

List Stock Transfer-In Records

Lists stock transfer-in records by page, filtered by market, status, and submission time. Used on the transfer-in records page. It also drives the in-progress notice on the transfer-in home page: pass state=5, page=1, and size=1, use total as the number of requests in progress, and when total is 1, open the details with records[0].id.

To filter by account, pass the account aaid (from GET /v3/account/list) in the x-target-aaid request header. Fewer than size records means there is no next page.

When calling through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v3/portfolio/rollover/record

Parameters

pagestringqueryRequired

Page number, starting from 1

sizestringqueryRequired

Records per page

marketstringqueryRequired

Market code; pass an empty string for all markets

statestringqueryRequired

Status filter using the values of state_code (0 submitted, 1 cancelled, 3 deposited, 5 in progress, 7 partially deposited, 8 failed); pass an empty string for all statuses

startstringqueryRequired

Lower bound of submission time, as a Unix timestamp in seconds; 0 means no limit

endstringqueryRequired

Upper bound of submission time, as a Unix timestamp in seconds; 0 means no limit

account_channelstringquery

Broker channel

x-target-aaidstringheader

Account aaid used to filter records by account

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Stock Transfer-In Records” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total number of matching records

recordsarray<object>

Records on the current page

Child attributes
idinteger

Transfer-in request id

aaidstring

aaid of the receiving account

marketstring

Transfer market

broker_idinteger

Delivering broker id; 0 means a manually entered broker

brokerstring

Delivering broker name

broker_enstring

Delivering broker name in English

codestring

Participant code of the delivering broker

accountstring

Account number of the Client at the delivering broker

namestring

Account holder name of the Client at the delivering broker

contactstring

Contact at the delivering broker

contact_emailstring

Email of the contact at the delivering broker

contact_phonestring

Phone number of the contact at the delivering broker

statestring

Status text for display

state_codeinteger

Request status code:

  • 0 - Submitted
  • 1 - Cancelled
  • 3 - Deposited
  • 5 - In progress
  • 7 - Partially deposited
  • 8 - Failed

Other values may appear; in that case rely on the state text.

can_modifyinteger

Whether the request can be modified or cancelled:

  • 1 - Yes; the modify and cancel endpoints can be called
  • 0 - No
app_statestring

Flag for whether the Client has notified the delivering broker; noticed means it has been marked as notified

attachmentsobject

Object storage keys of the supporting documents. Currently returned as a JSON-serialized string (such as ["<FILE_KEY_1>","<FILE_KEY_2>"]) that must be parsed first; a plain array is also possible

created_atinteger

Submission time, as a Unix timestamp in seconds

updated_atobject

Status update time, as a Unix timestamp in seconds; may be returned as a number or a string

process_atobject

Processing start time, as a Unix timestamp in seconds; may be returned as a number or a string

exec_atobject

Execution time, as a Unix timestamp in seconds; may be returned as a number or a string

reasonstring

Reason for cancellation, failure, or rejection

stocksarray<object>

Stocks to transfer in

Child attributes
counter_idstring

Security ID, such as ST/HK/700; may be missing, in which case identify the security by market and code

codestring

Stock code

namestring

Stock name

name_enstring

Stock name in English

marketstring

Market code, such as HK or US

currencystring

Settlement currency

amountnumber

Quantity to transfer in

costnumber

Cost price

stateinteger

Per-stock transfer status (returned by the details endpoint):

  • 0 - Processing
  • 1 - Succeeded
  • 2 - Failed
HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs