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
isSuccessboolWhether the request succeeded
dataReserveCashRecordCash reservation application details
messagestringError message when isSuccess is false

Cash reservation record: ReserveCashRecord fields

Return type : Object

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

Request example

sdk.Stock.ReserveCash(account, 10000)

Response example

{
isSuccess = True,
message = ,
data = ReserveCashRecord{
date = 2026/07/28, // Application date (string)
time = 10:53:23.000, // Application time (string)
seqNo = 118036, // Sequence number (string)
branchNo = 20207, // Branch code (string)
account = 9801163, // Account (string)
currency = TWD, // currency (string)
amount = 10000, // Pre-collected amount (int)
status = 10, // status (int)
}
}