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
statusreturned by this method as the result (10success;90failure). - For the complete workflow, see Reservations and Transfers.
Parameters
| Field | Type | Description |
|---|---|---|
| account | Account | Account |
| amount | int | Pre-collected amount in TWD; must be greater than 0 |
Result
| Field | Type | Description |
|---|---|---|
| is_success | bool | Whether the request succeeded |
| data | ReserveCashRecord | Cash reservation application details |
| message | string | Error message when is_success is false |
Cash reservation record: ReserveCashRecord fields
Return type : Object
| Field | Type | Description |
|---|---|---|
| seq_no | string | Sequence number |
| date | string | Application date |
| time | string | Application time |
| branch_no | string | Branch code |
| account | string | Account |
| currency | string | Currency: TWD |
| amount | int | Pre-collected amount (TWD) |
| status | int | Status: 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)
}}