Skip to main content
POST
Validate one proposed trade and optionally calculate risk.

Authorizations

Authorization
string
header
required

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

Body

JSON request with a non-null Position, optional caller RequestId, CalculateRisk (default false), and ReportingCurrency when risk is requested.

One proposed trade, optional caller correlation value, and choice to return pricing and risk data.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.TradeBooking.ApiValidateTradeRequest, Derivitec.Web.Core
reporting_currency
string | null

Currency in which monetary results are expressed. When null, the service uses the caller's configured reporting currency or USD.

Example:

"USD"

position
object

Typed position or trade input containing booking references, quantity, contract data, trade details, and optional organisation metadata.

request_id
string | null

Optional caller correlation value echoed unchanged in the response.

calculate_risk
boolean

Whether to attempt pricing details, market-data tables, and unit-risk data after parsing; defaults to false. These outputs can be absent when parsing or preparation fails.

Response

Returns the parsed trade and correlation identifier, plus optional pricing, market-data, and risk fields. Validation or calculation failures are carried in the payload.

Parsed trade and echoed correlation value, with risk outputs when requested preparation completes. Check ParsedTrades.IsValid because IsSuccess can remain true for a validation failure.

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

parsed_trades
object

Detailed validation result for parsed positions, including proposed changes, missing books, warnings, and contract models.

pricing_details
object

Collection of display-ready pricing details with an optional overall error message.

fair_unit_price
number<double> | null

The current fair price of one unit of the validated contract.

requires_unit_price
boolean

Whether booking this contract requires the user to supply a price paid.

unit_price_tool_tip
string | null

Help text for the price paid input when a unit price is required.

data_tables
object[] | null

Product-specific market-data tables returned only when risk calculation is requested and trade preparation succeeds.

tradable_risk_data
object

Unit-risk values and an optional diagnostic for one tradable.

request_id
string | null

Caller correlation value copied from the validation request.