Skip to main content

Cash Reservation Application

ReserveCash

Version

Available in v2.2.9 and later.

Usage limits
  • Applications are accepted on trading days from 08:00 to 14:30. Requests outside this window are rejected by the backend.
  • An application cannot be cancelled through the API after it is submitted.
  • Use the status returned by this method as the result (10 success; 90 failure).
  • For the complete workflow, see Reservations and Transfers.

Parameters

FieldTypeDescription
accountAccountAccount
amountintPre-collected amount in TWD; must be greater than 0

Result

FieldTypeDescription
is_successboolWhether the request succeeded
dataReserveCashRecordCash reservation application details
messagestringError message when is_success is false

Cash reservation record: ReserveCashRecord fields

Return type : Object

FieldTypeDescription
seq_nostringSequence number
datestringApplication date
timestringApplication time
branch_nostringBranch code
accountstringAccount
currencystringCurrency: TWD
amountintPre-collected amount (TWD)
statusintStatus: 10 success; 90 failure

Request example

auto reserve_cash_response = sdk->stock->reserve_cash(target_account, 10000);


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

Response example

// Output using custom .cpp and .hpp helpers
[ReserveCashRecord]
seq_no: 118036 // Sequence number (string)
date: 2026/07/28 // Application date (string)
time: 10:53:23.000 // Application time (string)
branch_no: 20207 // Branch code (string)
account: 9801163 // Account (string)
currency: TWD // currency (string)
amount: 10000 // Pre-collected amount (int)
status: 10 // status (int)