Skip to main content
GET
Retrieve one booked trade and whether the caller may reverse it.

Authorizations

Authorization
string
header
required

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

Path Parameters

tradeId
integer<int32>
required

The identifier of the booked trade.

Response

Returns the trade with IsSuccess = true, or IsSuccess = false when the trade does not exist or the caller cannot see every book it affected.

What one booked trade did: when it was booked, by whom, which books it moved, and whether the caller may reverse it.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.TradeBooking.ApiGetTradeDetailsResponse, 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>

Identifies the trade, and is what a reversal request quotes back.

trade_date
string | null

When the trade was booked, as an ISO 8601 round-trip timestamp carrying the offset of the time zone the request asked for, or UTC when it asked for none.

Example:

"2026-09-07T14:32:10.0000000+01:00"

booked_by_user_name
string | null

Who booked the trade, by display name. Falls back to their user id, and then to the caller's own id, when the trade records no name.

can_reverse
boolean

Whether the caller may reverse this trade, which requires edit access to every book it touched. A caller who can see the trade cannot necessarily undo it.

position_effects_by_book
object[] | null

The quantity changes the trade made, grouped by the book they landed in. A trade spanning several books has one entry per book.