Skip to main content

Cash Reservation Application

reserve_cash

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

sdk.stock.reserve_cash(account, 10000)

Response example

Result {
is_success: True,
message: None,
data : ReserveCashRecord {
date: "2026/07/28", # Application date (string)
time: "10:53:23.000", # Application time (string)
seq_no: "118036", # Sequence number (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)
}}