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
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 | number | Pre-collected amount in TWD; must be greater than 0 |
Result
| Field | Type | Description |
|---|---|---|
| isSuccess | bool | Whether the request succeeded |
| data | ReserveCashRecord | Cash reservation application details |
| message | string ? (optional) | Error message when isSuccess is false |
Cash reservation record: ReserveCashRecord fields
Return type : Object
| Field | Type | Description |
|---|---|---|
| seqNo | string | Sequence number |
| date | string | Application date |
| time | string | Application time |
| branchNo | string | Branch code |
| account | string | Account |
| currency | string | Currency: TWD |
| amount | number | Pre-collected amount (TWD) |
| status | number | Status: 10 success; 90 failure |
Request example
sdk.stock.reserveCash(account, 10000)
Response example
{
isSuccess: true,
data: {
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)
}
}