Docs
Waves

Cancel a multi-account order before it is sent

POST
/v1/execution-waves/{id}/cancel

Only while nothing has been sent. Once orders are going out there is no cancelling them — cancelled would claim nothing was sent, and that is exactly the promise we can no longer make.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry an environment (live or test) in the key itself, so a test key pasted into a production config fails immediately instead of at the worst possible moment.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/execution-waves/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "label": null,    "clientWaveId": null,    "symbol": "string",    "side": "buy",    "baseVolume": null,    "state": "planned",    "stateDetail": null,    "barrierPolicy": "release-ready",    "executeAt": null,    "expiresAt": null,    "preparedAt": null,    "releasedAt": null,    "settledAt": null,    "dispatchSpreadMs": null,    "summary": {      "total": 0,      "filled": 0,      "rejected": 0,      "skipped": 0,      "unresolved": 0    },    "legs": [      {        "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",        "orderId": null,        "volume": null,        "state": "pending",        "stateDetail": null,        "sentAt": null,        "settledAt": null      }    ],    "createdAt": "2019-08-24T14:15:22Z"  }}