Cancel Pending Trades List
MngCancelPendingTradesList¶
Description: Allows a manager to submit cancel requests for multiple pending trade orders by providing a list of order IDs.
Warning
this method work only for pending trades
Access Control¶
Requires dealer_trades for manager/dealer sessions. The target account must also match the manager groups and brand scope loaded from the cached manager record. Token payload is used only for manager id and session type.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| orders | array | Yes | List of pending trade order IDs to cancel |
| __access | object | Yes | Access object containing session type information |
Request Example¶
{
"orders": [1001234, 1001235, 1001236],
"__access": {
"type": 1
}
}
Response Parameters¶
| Name | Type | Description |
|---|---|---|
| rows | array | Successful cancel acknowledgments |
| matched | integer | Total number of requested orders |
| cancelled | integer | Number of orders accepted for cancel processing |
| failed | integer | Number of orders that failed validation or enqueue |
| failures | array | Optional per-order error details for failed cancel requests |
Response Example¶
{
"rows": [
{
"accepted": true,
"order": 1001234,
"state": 9
},
{
"accepted": true,
"order": 1001235,
"state": 9
}
],
"matched": 3,
"cancelled": 2,
"failed": 1,
"failures": [
{
"order": 1001236,
"error": "RET_NOT_FOUND",
"message": "Pending trade not found"
}
]
}
Notes¶
- A successful response is an acknowledgment that the cancel request was accepted, not confirmation that the pending order is already cancelled.
orderis the correlation identifier for subsequent trade lifecycle events.- If no orders are accepted, the method returns
409. - If some orders are accepted and some fail, the method returns
207.