Skip to content
Deposit Records

Get Deposit Records

Queries the deposit requests (deposit notifications) of the current account with pagination, with filters for status, currency, and notification time range. Used to display the deposit record list. When the Client selects a record, call GET /v2/portfolio/deposit/detail with items[].id.

Pagination: page starts at 1; when the number of loaded items reaches total, there is no more data. When from_date and to_date are passed, the service may return every record in that time range and ignore page. Clients without an opened securities account use GET /v4/portfolio/deposit/notify/no/trade/auth, a version that returns the same data without trading password verification and takes the same parameters.

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

GEThttps://api.lbkrs.com/v5/portfolio/deposit/notify

Parameters

pageintegerqueryRequired

Page number, starting from 1

sizeintegerqueryRequired

Page size. The Broker App uses 20

account_channelstringquery

Broker channel

statesstringquery

Filter by status, using the values of items[].state_code in the response, such as 0. Omit it to return every status

currenciesstringquery

Filter by currency, such as HKD. Omit it to return every currency

from_datestringquery

Start of the notification time range, as a Unix timestamp in seconds. Pass it together with to_date

to_datestringquery

End of the notification time range, as a Unix timestamp in seconds. Pass it together with from_date

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Deposit Records” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total number of matching records

itemsarray<object>

Deposit records

Child attributes
idinteger

Deposit request id, used to query the deposit details

order_idstring

Deposit order number

amountstring

Notified amount, which is the deposit amount declared by the Client

currencystring

Deposit currency

receivable_amountstring

Credited amount. Meaningful only after the deposit is credited

created_atinteger

Notification time, as a Unix timestamp in seconds

state_codeinteger

Deposit request status:

  • 0 - Processing
  • 1 - Credited
  • 2 - Failed
  • 3 - Cancelled
  • 4 - Voided
  • 5 - Rejected
  • 11 - Returned

0 is the only non-terminal status; all other values are terminal.

Values
0
1
2
3
4
5
11
vouchersarray<object>

Deposit proof images

Child attributes
img_urlstring

Proof image URL

Whale Docs