Skip to main content
POST
Cancel a booked trade by booking an offsetting one.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

JSON request with TradeId, the identifier of the trade to reverse.

Asks for a booked trade to be undone by booking an offsetting one. The original trade is left in place, so the book keeps a record of both.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.TradeBooking.ApiReverseTradeRequest, Derivitec.Web.Core
trade_id
integer<int32>

Identifies the trade to reverse. The caller needs edit access to every book it touched.

Response

Returns the offsetting trade's identifier with IsSuccess = true, or IsSuccess = false and the reason when the trade was not found, has nothing to reverse, or the caller lacks edit access to one of its books.

The outcome of reversing a booked trade.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.TradeBooking.ApiReverseTradeResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

trade_id
integer<int32> | null

Identifies the offsetting trade that was booked, not the trade that was reversed. Null when no reversal was booked, in which case the request reports failure and says why.