UnderlyingCapValue (FIX tag 1038)

AmtFIX 5.0 SP2

UnderlyingCapValue (tag 1038) is an Amt field defined in FIX 5.0 SP2. It appears in 68 message types, always optionally.

At a glance

Tag
1038
Name
UnderlyingCapValue
Datatype
Amt (float)
Dialects
FIX 5.0 SP2
Messages
68

What the specification says

Maximum notional value for a capped financial instrument

Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.

A real message using tag 1038

NewOrderSingle · FIX 5.0 SP2
TagFieldWire valueMeaning
8BeginStringFIXT.1.1
9BodyLength171
35MsgTypeDNewOrderSingle
49SenderCompIDBOARTEAM
56TargetCompIDCOUNTERPARTY
34MsgSeqNum2
52SendingTime20240101-12:00:00.000
11ClOrdIDORD-10042
711NoUnderlyings2 entries2repeating group
311UnderlyingSymbolEXAMPLE
1038UnderlyingCapValue125000.00
311UnderlyingSymbolEXAMPLE
1038UnderlyingCapValue125000.00
54Side1Buy
60TransactTime20240101-12:00:00.000
40OrdType1Market
10CheckSum139
Edit and decode it yourself

Shown with | separators for readability. On the wire FIX uses SOH (0x01), an invisible control byte — and because BodyLength and CheckSum are computed over the actual bytes, the two forms have different checksums. Both are valid and both decode here.

Open in the full decoder →

Generated from the FIX 5.0 SP2 dictionary and verified at build time: it parses and validates with no issues. Open the decoder to try your own message.

Where tag 1038 appears

Requiredness is a property of the message, not of the field: the same tag can be optional in one message and conditionally required in another.

MessageMsgTypeRequirednessWhere in the message
Advertisement7Optionalinside UndInstrmtGrp › UnderlyingInstrument
AllocationInstructionJOptionalinside UndInstrmtGrp › UnderlyingInstrument
AllocationInstructionAlertBMOptionalinside UndInstrmtGrp › UnderlyingInstrument
AllocationReportASOptionalinside UndInstrmtGrp › UnderlyingInstrument
AssignmentReportAWOptionalinside UndInstrmtGrp › UnderlyingInstrument
CollateralAssignmentAYOptionalinside UndInstrmtCollGrp › UnderlyingInstrument
CollateralInquiryBBOptionalinside UndInstrmtGrp › UnderlyingInstrument
CollateralInquiryAckBGOptionalinside UndInstrmtGrp › UnderlyingInstrument
CollateralReportBAOptionalinside UndInstrmtGrp › UnderlyingInstrument
CollateralRequestAXOptionalinside UndInstrmtCollGrp › UnderlyingInstrument
CollateralResponseAZOptionalinside UndInstrmtCollGrp › UnderlyingInstrument
ConfirmationAKOptionalinside UndInstrmtGrp › UnderlyingInstrument
ContraryIntentionReportBOOptionalinside UndInstrmtGrp › UnderlyingInstrument
CrossOrderCancelReplaceRequesttOptionalinside UndInstrmtGrp › UnderlyingInstrument
CrossOrderCancelRequestuOptionalinside UndInstrmtGrp › UnderlyingInstrument
DerivativeSecurityListAAOptionalinside the UnderlyingInstrument component
DerivativeSecurityListRequestzOptionalinside the UnderlyingInstrument component
DerivativeSecurityListUpdateReportBROptionalinside the UnderlyingInstrument component
DontKnowTradeQOptionalinside UndInstrmtGrp › UnderlyingInstrument
EmailCOptionalinside UndInstrmtGrp › UnderlyingInstrument
ExecutionAcknowledgementBNOptionalinside UndInstrmtGrp › UnderlyingInstrument
ExecutionReport8Optionalinside UndInstrmtGrp › UnderlyingInstrument
IOI6Optionalinside UndInstrmtGrp › UnderlyingInstrument
ListStrikePricemOptionalinside InstrmtStrkPxGrp › UndInstrmtGrp › UnderlyingInstrument
MarketDataIncrementalRefreshXOptionalinside MDIncGrp › UndInstrmtGrp › UnderlyingInstrument
MarketDataRequestVOptionalinside InstrmtMDReqGrp › UndInstrmtGrp › UnderlyingInstrument
MarketDataSnapshotFullRefreshWOptionalinside UndInstrmtGrp › UnderlyingInstrument
MassQuoteiOptionalinside QuotSetGrp › UnderlyingInstrument
MassQuoteAcknowledgementbOptionalinside QuotSetAckGrp › UnderlyingInstrument
MultilegOrderCancelReplaceACOptionalinside UndInstrmtGrp › UnderlyingInstrument
NewOrderCrosssOptionalinside UndInstrmtGrp › UnderlyingInstrument
NewOrderListEOptionalinside ListOrdGrp › UndInstrmtGrp › UnderlyingInstrument
NewOrderMultilegABOptionalinside UndInstrmtGrp › UnderlyingInstrument
NewOrderSingleDOptionalinside UndInstrmtGrp › UnderlyingInstrument
NewsBOptionalinside UndInstrmtGrp › UnderlyingInstrument
OrderCancelReplaceRequestGOptionalinside UndInstrmtGrp › UnderlyingInstrument
OrderCancelRequestFOptionalinside UndInstrmtGrp › UnderlyingInstrument
OrderMassActionReportBZOptionalinside the UnderlyingInstrument component
OrderMassActionRequestCAOptionalinside the UnderlyingInstrument component
OrderMassCancelReportrOptionalinside the UnderlyingInstrument component
OrderMassCancelRequestqOptionalinside the UnderlyingInstrument component
OrderMassStatusRequestAFOptionalinside the UnderlyingInstrument component
OrderStatusRequestHOptionalinside UndInstrmtGrp › UnderlyingInstrument
PositionMaintenanceReportAMOptionalinside UndInstrmtGrp › UnderlyingInstrument
PositionMaintenanceRequestALOptionalinside UndInstrmtGrp › UnderlyingInstrument
PositionReportAPOptionalinside PosUndInstrmtGrp › UnderlyingInstrument
QuoteSOptionalinside UndInstrmtGrp › UnderlyingInstrument
QuoteCancelZOptionalinside QuotCxlEntriesGrp › UndInstrmtGrp › UnderlyingInstrument
QuoteRequestROptionalinside QuotReqGrp › UndInstrmtGrp › UnderlyingInstrument
QuoteRequestRejectAGOptionalinside QuotReqRjctGrp › UndInstrmtGrp › UnderlyingInstrument
QuoteResponseAJOptionalinside UndInstrmtGrp › UnderlyingInstrument
QuoteStatusReportAIOptionalinside UndInstrmtGrp › UnderlyingInstrument
QuoteStatusRequestaOptionalinside UndInstrmtGrp › UnderlyingInstrument
RFQRequestAHOptionalinside RFQReqGrp › UndInstrmtGrp › UnderlyingInstrument
RequestForPositionsANOptionalinside UndInstrmtGrp › UnderlyingInstrument
RequestForPositionsAckAOOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityDefinitiondOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityDefinitionRequestcOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityDefinitionUpdateReportBPOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityListyOptionalinside SecListGrp › UndInstrmtGrp › UnderlyingInstrument
SecurityListRequestxOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityListUpdateReportBKOptionalinside SecLstUpdRelSymGrp › UndInstrmtGrp › UnderlyingInstrument
SecurityStatusfOptionalinside UndInstrmtGrp › UnderlyingInstrument
SecurityStatusRequesteOptionalinside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportAEOptionalinside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportAckAROptionalinside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportRequestADOptionalinside UndInstrmtGrp › UnderlyingInstrument
TradeCaptureReportRequestAckAQOptionalinside UndInstrmtGrp › UnderlyingInstrument

Wire format

A decimal monetary amount, in the currency named by the message's currency field. @boarteam/fix parses the value as a number and reports parse/invalid-float when it does not lex as one; the raw string is kept so precision and trailing zeros are never lost.

Read tag 1038 in TypeScript

decode.tsts
import { createFixEngine } from "@boarteam/fix";import { dictionary } from "@boarteam/fix-dict-fix50sp2";const fix = createFixEngine(dictionary);const { message, issues } = fix.parse(raw);const field = message.fields[1038];field?.name;   // "UnderlyingCapValue"field?.raw;    // the verbatim wire stringfield?.value;  // coerced to a number

Other Amt fields

Decode this in your own code

The same engine that produced the decoded example above is an Apache-2.0 npm package with zero runtime dependencies. It runs in Node and in the browser, and parse() returns problems as data instead of throwing.

npm i @boarteam/fix @boarteam/fix-dict-fix50sp2