Commodities blotter records

This page describes the FX API’s commodities blotter records.

This documentation is for the FX Integration API 8.3.0.

Blotter record specifications

The FX API provides builders for the following commodities blotter records.

For high-level information on blotter record fields, see Message and record fields. For information about fields in specific blotter records, see the record specifications below.

CommoditiesTradeBlotterRecord
Example
API
CommoditiesTradeConfirmation
Example
API
CommonTradeConfirmationFields
API
TradingType
string
Caplin supported values are [FIXED_SWAP, BASIS_SWAP, EURO_PUT, EURO_CALL, EURO_COLLAR, EURO_3_WAY_COLLAR, EURO_CALL_SPREAD, ASIAN_CAP, ASIAN_FLOOR, ASIAN_COLLAR, ASIAN_3_WAY_COLLAR, ASIAN_CAP_SPREAD, ASIAN_FLOOR_SPREAD, SPREAD_PUT]. See the constants defined within com.caplin.motif.commodities.trading.CommoditiesTradingType for further details.
Commodity
string
The commodity of the trade.
TradeID
string
A unique identifier for this trade.
EffectiveDate
string
The date the trade comes into effect.
TerminationDate
string
The termination date of the trade.
TradeDate
string
Example: 20160314
ReferencePrice
decimal
The reference price of the traded commodity
PricingDate
string
The date the price was generated on.
PaymentDate
string
The date by when the payment needs to be done.
LEI
string
Legal entity identifier, unique number to identify the entity engaging in a financial transaction.
UPI
string
Unique product identifier, similar to USI/UTI but at product level not transaction level.
DealBreakdown
string
A JSON structure containing all the individual deals of a commodities trade. Use DefaultTableFields builders to provide Caplin default and/or custom fields.
SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
NextActionDeadline
datetime
Example: 2018-03-16T07:25:16+00:00
The deadline for a user to perform a trade's next action in ISO-8601 format
NextActionDeadlineDisplayTimezone
string
Example: America/New_York
The timezone for the NextActionDeadline field in the form Area/Location
TOBOUser
string
The user the trade is on behalf of.
EntityDescription
string
The entity the trade is on behalf of.
Market
string
Example: Metals
CanAffirm
boolean
Ability to Affirm the Trade Details are as agreed.
Unit
string
Example: bbl
Currency
string
The currency the transaction has been made in.
TotalPremium
decimal
The total premiums of deal breakdown. When there is no deal breakdown present it will be the actual premium paid for the deal.
EuroPutCallTradeConfirmationFields
API
Direction
string
The direction of the trade, from the client's perspective.
TotalQuantity
decimal
The total amounts of the deal breakdown.
Strike
decimal
The strike price of the commodity deal.
Premium
decimal
Example: 1000
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
PremiumPayer
string
The identifier for whoever is the premium payer.
Buyer
string
The buying entity's identifier.
Seller
string
The selling entity's identifier.
EuroCollarTradeConfirmationFields
API
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
Euro3WayCollarTradeConfirmationFields
API
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
EuroCallSpreadTradeConfirmationFields
API
Strike
decimal
The strike price of the commodity deal.
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
Buyer
string
The buying entity's identifier.
Seller
string
The selling entity's identifier.
AsianCapFloorTradeConfirmationFields
API
Direction
string
The direction of the trade, from the client's perspective.
TotalQuantity
decimal
The total amounts of the deal breakdown.
Strike
decimal
The strike price of the commodity deal.
Premium
decimal
Example: 1000
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
PremiumPayer
string
The identifier for whoever is the premium payer.
Buyer
string
The buying entity's identifier.
Seller
string
The selling entity's identifier.
AsianCollarTradeConfirmationFields
API
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
Asian3WayCollarTradeConfirmationFields
API
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
AsianCapFloorSpreadTradeConfirmationFields
API
Strike
decimal
The strike price of the commodity deal.
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
PremiumPayer
string
The identifier for whoever is the premium payer.
Buyer
string
The buying entity's identifier.
Seller
string
The selling entity's identifier.
SpreadPutTradeConfirmationFields
API
Direction
string
The direction of the trade, from the client's perspective.
TotalQuantity
decimal
The total amounts of the deal breakdown.
Strike
decimal
The strike price of the commodity deal.
Premium
decimal
Example: 1000
PremiumPaymentDate
string
The date by when the premium payment needs to be done.
PremiumPayer
string
The identifier for whoever is the premium payer.
FixedSwapTradeConfirmationFields
API
Direction
string
The direction of the trade, from the client's perspective.
TotalQuantity
decimal
The total amounts of the deal breakdown.
FixedPrice
decimal
The fixed price of the commodity deal.
FixedPricePayer
string
The identifier for whoever is the fixed price payer.
FloatingPricePayer
string
The identifier for whoever is the floating price payer
BasisSwapTradeConfirmationFields
API
Direction
string
The direction of the trade, from the client's perspective.
TotalQuantity
decimal
The total amounts of the deal breakdown.
FixedPrice
decimal
The fixed price of the commodity deal.
FixedPricePayer
string
The identifier for whoever is the fixed price payer.
FloatingPricePayer
string
The identifier for whoever is the floating price payer