Cancel a booked trade by booking an offsetting one.
Books a trade whose position effects negate the original’s. The original is left in place, so the book keeps both, and the response identifies the new offsetting trade rather than the one reversed. The caller needs edit access to every book the original touched; without it nothing is booked. This is a synchronous mutation and is not itself reversible except by reversing the offsetting trade.
Authorizations
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.
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.
Derivitec.Web.Core.TradeBooking.ApiReverseTradeResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.
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.