Error

A valid request URL is required to generate request examples

{
  "version": "external-order/v1",
  "orderId": "<string>",
  "accountId": "<string>",
  "marketId": "<string>",
  "status": "open",
  "lastSequence": 1,
  "idempotencyKey": "<string>",
  "cancelReason": "margin_unbacked"
}

{
  "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

Cancels the unfilled remainder of an owned resting order and returns status canceled. An exact replay with the same Idempotency-Key returns the original accepted response; a later cancellation with a new key returns not_found. Unknown, terminal, wrong-market, and other-account order ids all return not_found. Cancellation is allowed while a market is cancel_only, paused, or reduce_only, but a global engine halt refuses it. The venue charges no placement fee, so cancellation refunds and reverses nothing. A partially filled order keeps the maker or taker fees already charged for its fills.

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

Authentication: DFNS trader bearer required.

Request schema: PublicCancelOrderRequest.

Response schema: ExternalOrderResponse.

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

POST

orders

{orderId}

cancel

Error

A valid request URL is required to generate request examples

{
  "version": "external-order/v1",
  "orderId": "<string>",
  "accountId": "<string>",
  "marketId": "<string>",
  "status": "open",
  "lastSequence": 1,
  "idempotencyKey": "<string>",
  "cancelReason": "margin_unbacked"
}

{
  "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

Path Parameters

orderId

string

required

Minimum string length: 1

Body

application/json

accountId

string

required

Minimum string length: 1

marketId

string

required

Minimum string length: 1

Response

Accepted for processing

version

string

required

Allowed value: "external-order/v1"

orderId

string

required

Minimum string length: 1

accountId

string

required

Minimum string length: 1

marketId

string

required

Minimum string length: 1

status

enum<string>

required

Available options:

open,

partially_filled,

filled,

canceled,

replaced

lastSequence

integer

required

Required range: x >= 0

idempotencyKey

string

required

Minimum string length: 1

cancelReason

enum<string>

Available options:

margin_unbacked,

risk_evidence_incomplete,

market_session_closed

Account policy

External REST API

Cancel an order

Authorizations

Headers

Path Parameters

Body

Response