Skip to content
Withdrawals

Get Withdrawal Records

Queries the withdrawal request records of the current account with pagination, with filters for status, currency, and creation time range. Used to display the withdrawal record list. Get the selectable statuses from GET /v1/portfolio/withdraw/historyinfo; when the Client selects a record, call GET /v7/portfolio/withdraw/detail with list[].id.

Pagination: page starts at 1; when list contains fewer items than size, there is no more data. Some tenant channels use GET /v6/portfolio/withdraw/record/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/v6/portfolio/withdraw/record

Parameters

pageintegerquery

Page number, starting from 1

sizeintegerquery

Items per page; the Broker App uses 20

account_channelstringquery

Broker channel

statesstringquery

Status filter: comma-separated status keys from states[].key of GET /v1/portfolio/withdraw/historyinfo. Omit or leave empty for no filter

currencysstringquery

Currency filter, comma-separated, for example HKD,USD. Omit or leave empty for no filter

beginstringquery

Start of the creation time range as a Unix timestamp in seconds; pass it together with end

endstringquery

End of the creation time range as a Unix timestamp in seconds; pass it together with begin

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Withdrawal Records” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Withdrawal records

Child attributes
idinteger

Withdrawal request id, used to query the details

order_idstring

Withdrawal order number

amountstring

Withdrawal amount

currencystring

Withdrawal currency

feestring

Withdrawal fee

bank_accountstring

Receiving bank account number

created_atinteger

Creation time as a Unix timestamp in seconds

stateinteger

Withdrawal request status:

  • 0 - Submitted and being processed
  • 1 - Processing
  • 2 - Rejected
  • 3 - Cancelled by the Client
  • 4 - Remitted
  • 5 - Failed
  • 6 - Refunded
  • 7 - Approved but not yet remitted
  • 8 - Under large-amount withdrawal review
  • 9 - Modification pending approval
  • 10 - Deletion pending approval
  • 11 - Deleted
  • 12 - Rejection pending approval
  • 15 - To be confirmed: the Client must confirm a change of the receiving bank card before processing continues

Only requests in status 0 or 15 can be cancelled. When displaying the status, prefer the returned state_description.

Values
0
1
2
3
4
5
6
7
8
9
10
11
12
15
state_descriptionstring

Display text of the status; when empty, display by state

disable_linkboolean

Whether opening the details is disabled. When true, the record has no details entry

Whale Docs