Error

A valid request URL is required to generate request examples

{
  "version": "external-cancel-order-batch/v1",
  "outcomes": [
    {
      "index": 1,
      "accepted": true,
      "orderId": "<string>",
      "accountId": "<string>",
      "marketId": "<string>",
      "status": "open",
      "lastSequence": 1,
      "idempotencyKey": "<string>"
    }
  ]
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

Orders

Cancel an order batch

Cancels 1 to 24 named owned orders in one bounded writer turn. Every entry receives one indexed result in request order; accepted siblings remain committed when another entry is not found or already terminal. Exact idempotent replay returns the original decisions without another journal record. Cancellation remains available in cancel-only, paused, reduce-only, and closed market sessions, while a global engine halt refuses the batch.

Method and path: POST /v1/orders/batch/cancel

Authentication: DFNS trader bearer required.

Request schema: ExternalBatchCancelOrderRequest.

Response schema: ExternalBatchCancelOrderResponse.

Error envelope: ExternalRestError (external-rest-error/v1).

POST

orders

batch

cancel

Error

A valid request URL is required to generate request examples

{
  "version": "external-cancel-order-batch/v1",
  "outcomes": [
    {
      "index": 1,
      "accepted": true,
      "orderId": "<string>",
      "accountId": "<string>",
      "marketId": "<string>",
      "status": "open",
      "lastSequence": 1,
      "idempotencyKey": "<string>"
    }
  ]
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Minimum string length: 1

Body

application/json

orders

object[]

required

Required array length: 1 - 24 elements

Show child attributes

Response

Accepted for processing

version

string

required

Allowed value: "external-cancel-order-batch/v1"

outcomes

object[]

required

Required array length: 1 - 24 elements

Option 1
Option 2

Show child attributes

Account policy

External REST API

Cancel an order batch

Authorizations

Headers

Body

Response