Skip to main content

Cash Reservation Query

QueryReserves

Version

Available in v2.2.9 and later.

Parameters

FieldTypeDescription
accountAccountAccount

Result

FieldTypeDescription
isSuccessboolWhether the request succeeded
dataReserveCashSummaryAccount-wide pre-collected cash summary
messagestringError message when isSuccess is false

Pre-collected cash summary: ReserveCashSummary fields

Return type : Object

FieldTypeDescription
branchNostringBranch code
accountstringAccount
currencystringCurrency: TWD
reservedAmountintPre-collected amount (TWD)
returnedAmountintReturned amount (TWD)
orderedAmountintAmount used by orders (TWD)

Request example

sdk.Stock.QueryReserves(account)

Response example

{
isSuccess = True,
message = ,
data = ReserveCashSummary{
branchNo = 20207,
account = 9801163,
currency = TWD,
reservedAmount = 9960200,
returnedAmount = 0,
orderedAmount = 0
}
}