Cash Reservation Query
QueryReserves
Version
Available in v2.2.9 and later.
Parameters
| Field | Type | Description |
|---|---|---|
| account | Account | Account |
Result
| Field | Type | Description |
|---|---|---|
| isSuccess | bool | Whether the request succeeded |
| data | ReserveCashSummary | Account-wide pre-collected cash summary |
| message | string | Error message when isSuccess is false |
Pre-collected cash summary: ReserveCashSummary fields
Return type : Object
| Field | Type | Description |
|---|---|---|
| branchNo | string | Branch code |
| account | string | Account |
| currency | string | Currency: TWD |
| reservedAmount | int | Pre-collected amount (TWD) |
| returnedAmount | int | Returned amount (TWD) |
| orderedAmount | int | Amount 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
}
}