Cash Reservation Query

QueryReserves

Version

Available in v2.2.9 and later.

Parameters

Field	Type	Description
account	Account	Account

Result

Field	Type	Description
is_success	bool	Whether the request succeeded
data	ReserveCashSummary	Account-wide pre-collected cash summary
message	string	Error message when is_success is false

Pre-collected cash summary: ReserveCashSummary fields

Return type : Object

Field	Type	Description
branch_no	string	Branch code
account	string	Account
currency	string	Currency: TWD
reserved_amount	int	Pre-collected amount (TWD)
returned_amount	int	Returned amount (TWD)
ordered_amount	int	Amount used by orders (TWD)

Request example

auto reserves_response = sdk->stock->query_reserves(target_account);

// Output using custom .cpp and .hpp helpers
if (!reserves_response.is_success) {
    std::cout << "query reserves failed reason: "
        << (reserves_response.message.has_value() ? reserves_response.message.value() : "No message")
        << std::endl;
}
else {
    if (reserves_response.data.has_value()) {
        std::cout << reserves_response.data.value() << std::endl;
    }
    else {
        std::cout << "Query reserves success but no data returned." << std::endl;
    }
}

Response example

// Output using custom .cpp and .hpp helpers
[ReserveCashSummary]
  branch_no: 20207                 // Branch code (string)
  account: 9801163                 // Account (string)
  currency: TWD                    // currency (string)
  reserved_amount: 9960200         // pre-collected amount (int)
  returned_amount: 0               // returned amount (int)
  ordered_amount: 0                // amount used by orders (int)