Skip to main content
POST
Void a command

Authorizations

x-api-key
string
header
required

Body

application/json

The trading account and the key of the command to void

A command to void: the key it was sent under, on the account it was for.

For a caller whose command went unanswered. Voiding its key settles what became of it, for good: either the command was written, or it never will be.

idempotency_key
string
required

The Idempotency-Key the command was submitted under.

trading_account_id
string<uuid>
required

Trading account the command was for.

intent_id
string<uuid> | null

The intent the command was on: the one a create named, or the one a replace or cancel referenced. Recorded with the void, never checked.

Response

The key is settled. VOIDED: no command was or will be written under it. WRITTEN: the command was written before the void

The answer to a void: final either way, however long the command's own write took.

outcome
enum<string>
required

What became of the command a void named.

Available options:
VOIDED,
WRITTEN
intent_id
string<uuid> | null

The written command's intent. For a voided key, the intent the void named, if it named one.