Blotter record specification

Subscription subjects used to populate FX Mobile blotters must conform to the appropriate specification below.

Trade blotter record specifications

FX Mobile supports blotter records built using the FX Integration API 3’s blotter record builders.

FX Integration API version: 8.14.0.

SpotBlotterRecord
Example
API
CommonBlotterFields
API
BaseCurrency
string
Example: USD
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
ExecutionStyle
string
The execution style. Caplin supported types are [ORDER, RFS, ESP]
USI
string
Unique swap identifier, global unique transaction identifier.
CommonSpotTradeConfirmation
Example
API
CommonTradeConfirmationFields
API
TradeID
string
Example: 00001561
A unique identifier for this trade
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
DealtCurrency
string
Example: GBP
The currency of the Amount of a trade or order.
SpotRate
decimal
Example: 1.08341
SpotMidRate
decimal
Example: 1.08345
The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
SpotRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
ExecutionDateTime
string
Example: 20160322123621
TradeDate
string
Example: 20160314
Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
TraderUsername
string
Example: sales_trader@novobank.co.za
The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.
TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
FullName
string
The full name of the user the trade is on behalf of
EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
string
Example: FX
A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
DeliverableType
string
Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)
DigitsBeforePips
integer
Example: 2
Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this field will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
NumberOfPips
integer
Example: 2
Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.
OrderID
string
The id of the order.
WarningCode
string
Example: 001
The code for the warning regarding a quote request.
WarningMessage
string
Example: **CREDIT CHECK:** This user has a credit limit of **1,000,000.00 USD** which should not be exceeded.
The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.
DetailedWarningMessage
string
Example: color: {{theme:foreground.semantic.warning_inverse}}
Client
string
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
CostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
ContraCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
ServiceCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
ServiceContraCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
CanAllocate
string
Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL
CanDrawdown
boolean
Ability to Drawdown a time option trade.
AllocationSettlementDateOptions
string
Example: ORIGINAL,EARLIER,LATER
Comma-separated list, defines available settlement dates for an allocation.
IsAllocated
boolean
Deprecated, use HasPostTradeHistory instead.
HasPostTradeHistory
boolean
Define whether post-trade history (related deals e.g. drawdowns, allocations, early take ups and roll overs) is available.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
AmountDPS
integer
Example: 2
The precision for a specified currency pair and dealt currency
ContraAmountDPS
integer
Example: 2
The precision for a specified currency pair and contra currency
Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
UTI
string
Unique Transaction Identifier.
BackOfficeID
string
Back office trade identifier.
PriceSource
string
Example: st1@caplin.com
Identifies the person or system that priced the trade.
Venue
string
Example: FX Sales
Where the trade was placed.
Purpose
string
Example: Commercial
The purpose of a trade.
Tags
string
Example: method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}
Tags for a trade.
ClientAgreementDateTime
datetime
Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
PostTradeType
string
The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION, DRAWDOWN
OriginalTradeID
string
TradeID of the trade that this trade was created from.
Status
string
Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.
NaturalLanguageSummaryHidden
boolean
When true, the natural language summary will be hidden on the RFS ticket summary.
IsCommercial
boolean
Indicates whether the given trade is commercial or not
LegTradeConfirmationFields L1
API
SettlementTradeFields L1
API
SettlementFields L1_Pay[n]
API
L1_Pay[n]SettlementId
string
The identifier for the settlement instruction.
L1_Pay[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_Pay[n]SettlementAmount
decimal
The amount of a settlement
L1_Pay[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_Pay[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_Pay[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_Pay[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_Pay[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_Pay[n]BankAccount
string
Example: 12345678
The account number of the bank
L1_Pay[n]BankSwift
string
Example: CAP123
The BIC of the bank
L1_Pay[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L1_Pay[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_Pay[n]BankAddress2
string
Example: The City
The second line of the bank's address
L1_Pay[n]BankAddress3
string
Example: London
The third line of the bank's address
L1_Pay[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_Pay[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_Pay[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_Pay[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_Pay[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_Pay[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L1_Pay[n]SplitComponentId
string
The unique ID of a split component
L1_Pay[n]SettlementDetailsLine1
string
The first line of remittance information.
L1_Pay[n]SettlementDetailsLine2
string
The second line of remittance information.
L1_Pay[n]SettlementDetailsLine3
string
The third line of remittance information.
L1_Pay[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L1_Pay[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L1_Pay[n]SettlementDetailsLine6
string
The sixth line of remittance information.
SettlementFields L1_Receive[n]
API
L1_Receive[n]SettlementId
string
The identifier for the settlement instruction.
L1_Receive[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_Receive[n]SettlementAmount
decimal
The amount of a settlement
L1_Receive[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_Receive[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_Receive[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_Receive[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_Receive[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_Receive[n]BankAccount
string
Example: 12345678
The account number of the bank
L1_Receive[n]BankSwift
string
Example: CAP123
The BIC of the bank
L1_Receive[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L1_Receive[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_Receive[n]BankAddress2
string
Example: The City
The second line of the bank's address
L1_Receive[n]BankAddress3
string
Example: London
The third line of the bank's address
L1_Receive[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_Receive[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_Receive[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_Receive[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_Receive[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_Receive[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L1_Receive[n]SplitComponentId
string
The unique ID of a split component
L1_Receive[n]SettlementDetailsLine1
string
The first line of remittance information.
L1_Receive[n]SettlementDetailsLine2
string
The second line of remittance information.
L1_Receive[n]SettlementDetailsLine3
string
The third line of remittance information.
L1_Receive[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L1_Receive[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L1_Receive[n]SettlementDetailsLine6
string
The sixth line of remittance information.
NettingComponents L1_PayNettingComponents[n]
API
L1_PayNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L1_PayNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_PayNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
NettingComponents L1_ReceiveNettingComponents[n]
API
L1_ReceiveNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L1_ReceiveNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_ReceiveNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
L1_CanAffirm
boolean
Ability to Affirm the Trade Details are as agreed.
L1_CanConfirm
boolean
Ability to Confirm the Settlement Details are now final.
L1_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L1_CanDispute
boolean
Ability to Dispute the details of a trade, if for example something is wrong about it.
L1_CanCancel
boolean
Ability to Cancel a trade, for example if a mistake was made.
L1_CanReplace
boolean
Ability to mark a deal as amended, meaning that it has been replaced by a corrected deal.
L1_CanAutoConfirm
boolean
Ability to Mark that the deal was Confirmed by the Bank, rather than by the client.
L1_CanUnconfirm
boolean
Ability to move the deal back to a Pending state.
L1_CanApproveInstructions
boolean
Can approve settlement instructions for a trade.
L1_CanRejectInstructions
boolean
Can reject settlement instructions for a trade.
L1_CanRelease
boolean
Relates to post trade actions: User can release the trade
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_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
L1_NextActionDeadlineDisplayTimezone
string
Example: America/New_York
The timezone for the NextActionDeadline field in the form Area/Location
L1_AffirmedBy
string
The name of the user who affirmed a trade.
L1_AffirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was affirmed in ISO-8601 format
L1_ConfirmedBy
string
The name of the user who confirmed a trade.
L1_ConfirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was confirmed in ISO-8601 format
L1_IsPayNetted
boolean
Denotes whether the pay side of a trade has been netted.
L1_IsReceiveNetted
boolean
Denotes whether the receive side of a trade has been netted.
L1_IsPayNettingRequired
boolean
Denotes whether the pay side of a trade requires netting.
L1_IsReceiveNettingRequired
boolean
Denotes whether the receive side of a trade requires netting.
L1_IsPaySplit
boolean
Denotes whether the pay side of a trade has been split.
L1_IsReceiveSplit
boolean
Denotes whether the receive side of a trade has been split.
NostroAccount L1
API
L1_NostroName
string
Example: GBP Nostro Account.
An identifier for the given nostro account.
L1_NostroBIC
string
Example: ARABAEADABC
The Bank Identifier Code denoting the bank which will receive the money.
L1_NostroAccount
string
Example: AE770090004000824676500
The account at the bank denoted by the NostroBIC field that will receive the money.
RemarksEntry L1_Remarks[n]
API
L1_Remarks[n]Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
L1_Remarks[n]RemarkDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The date and time a remark was left on in ISO-8601 format.
L1_Remarks[n]RemarkSource
string
The username of the person who left a remark on a trade.
L1_Remarks[n]RemarkOriginStatus
string
Additional remark field pointing at the previous status of the trade.
L1_Remarks[n]RemarkTargetStatus
string
Additional remark field pointing at the current status of the trade when the remark was added.
L1_TradeID
string
Example: 00001561
A unique identifier for this trade
L1_AllInRate
decimal
Example: 1.091790
L1_AllInRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
L1_AllInMidRate
decimal
Example: 1.091790
The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
L1_FwdPoints
decimal
Example: 0.001198
L1_FwdMidPoints
decimal
Example: 0.005390
The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.
L1_FwdPips
string
Example: 11.98
L1_BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_Amount
decimal
The amount of a trade or order in the DealtCurrency.
L1_ContraAmount
decimal
Example: 350
The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.
L1_Tenor
string
Example: 1M
Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.
L1_SettlementDate
string
L1_FilledAmount
decimal
Example: 0
L1_RemainingAmount
decimal
Example: 500
L1_RiskDate
string
Example: 20160314
The date in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_RiskTenor
string
Example: 1W
The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_StartDate
string
Example: 20150620
L1_StartTenor
string
Example: 1W
L1_IsTimeOption
boolean
Example: true
true if a leg is time-option
L1_Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
L1_Profit
decimal
Example: 1000
The sales profit in the specified currency.
L1_CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
L1_EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
L1_EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
L1_CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
L1_CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
L1_ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
L1_ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
L1_ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
L1_ServiceContraCostAmount
decimal
The actual service cost of performing the trade to the client on the contra currency
L1_ServiceContraCostCurrency
string
Example: GBP
The service contra currency that the cost is displayed in
L1_ServiceCostAmount
decimal
The actual service cost of performing the trade to the client on the home currency
L1_ServiceCostCurrency
string
Example: GBP
The service home currency that the cost is displayed in
L1_TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
L1_FullName
string
The full name of the user the trade is on behalf of
L1_ForwardPointsDecimalOffset
integer
Example: 4
Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.
L1_AllocatableAmount
decimal
Example: 500
This is the amount that can be allocated or rolled.
L1_AllocatableContraAmount
decimal
Example: 500
This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency
L1_OriginalRate
decimal
The Rate of the trade that this trade was created from.
L1_AdjustedSwapPoints
decimal
The swap points adjusted for this repriced trade
This message has no fields that you can set.
This message has no fields that you can set.
ForwardBlotterRecord
Example
API
CommonBlotterFields
API
BaseCurrency
string
Example: USD
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
ExecutionStyle
string
The execution style. Caplin supported types are [ORDER, RFS, ESP]
USI
string
Unique swap identifier, global unique transaction identifier.
CommonForwardTradeConfirmation
Example
API
CommonTradeConfirmationFields
API
TradeID
string
Example: 00001561
A unique identifier for this trade
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
DealtCurrency
string
Example: GBP
The currency of the Amount of a trade or order.
SpotRate
decimal
Example: 1.08341
SpotMidRate
decimal
Example: 1.08345
The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
SpotRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
ExecutionDateTime
string
Example: 20160322123621
TradeDate
string
Example: 20160314
Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
TraderUsername
string
Example: sales_trader@novobank.co.za
The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.
TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
FullName
string
The full name of the user the trade is on behalf of
EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
string
Example: FX
A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
DeliverableType
string
Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)
DigitsBeforePips
integer
Example: 2
Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this field will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
NumberOfPips
integer
Example: 2
Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.
OrderID
string
The id of the order.
WarningCode
string
Example: 001
The code for the warning regarding a quote request.
WarningMessage
string
Example: **CREDIT CHECK:** This user has a credit limit of **1,000,000.00 USD** which should not be exceeded.
The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.
DetailedWarningMessage
string
Example: color: {{theme:foreground.semantic.warning_inverse}}
Client
string
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
CostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
ContraCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
ServiceCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
ServiceContraCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
CanAllocate
string
Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL
CanDrawdown
boolean
Ability to Drawdown a time option trade.
AllocationSettlementDateOptions
string
Example: ORIGINAL,EARLIER,LATER
Comma-separated list, defines available settlement dates for an allocation.
IsAllocated
boolean
Deprecated, use HasPostTradeHistory instead.
HasPostTradeHistory
boolean
Define whether post-trade history (related deals e.g. drawdowns, allocations, early take ups and roll overs) is available.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
AmountDPS
integer
Example: 2
The precision for a specified currency pair and dealt currency
ContraAmountDPS
integer
Example: 2
The precision for a specified currency pair and contra currency
Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
UTI
string
Unique Transaction Identifier.
BackOfficeID
string
Back office trade identifier.
PriceSource
string
Example: st1@caplin.com
Identifies the person or system that priced the trade.
Venue
string
Example: FX Sales
Where the trade was placed.
Purpose
string
Example: Commercial
The purpose of a trade.
Tags
string
Example: method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}
Tags for a trade.
ClientAgreementDateTime
datetime
Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
PostTradeType
string
The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION, DRAWDOWN
OriginalTradeID
string
TradeID of the trade that this trade was created from.
Status
string
Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.
NaturalLanguageSummaryHidden
boolean
When true, the natural language summary will be hidden on the RFS ticket summary.
IsCommercial
boolean
Indicates whether the given trade is commercial or not
NDFTradeConfirmationFields
API
FixingSource
string
Example: WMR 8am London Time
SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
LegTradeConfirmationFields L1
API
SettlementTradeFields L1
API
SettlementFields L1_Pay[n]
API
L1_Pay[n]SettlementId
string
The identifier for the settlement instruction.
L1_Pay[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_Pay[n]SettlementAmount
decimal
The amount of a settlement
L1_Pay[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_Pay[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_Pay[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_Pay[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_Pay[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_Pay[n]BankAccount
string
Example: 12345678
The account number of the bank
L1_Pay[n]BankSwift
string
Example: CAP123
The BIC of the bank
L1_Pay[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L1_Pay[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_Pay[n]BankAddress2
string
Example: The City
The second line of the bank's address
L1_Pay[n]BankAddress3
string
Example: London
The third line of the bank's address
L1_Pay[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_Pay[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_Pay[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_Pay[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_Pay[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_Pay[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L1_Pay[n]SplitComponentId
string
The unique ID of a split component
L1_Pay[n]SettlementDetailsLine1
string
The first line of remittance information.
L1_Pay[n]SettlementDetailsLine2
string
The second line of remittance information.
L1_Pay[n]SettlementDetailsLine3
string
The third line of remittance information.
L1_Pay[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L1_Pay[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L1_Pay[n]SettlementDetailsLine6
string
The sixth line of remittance information.
SettlementFields L1_Receive[n]
API
L1_Receive[n]SettlementId
string
The identifier for the settlement instruction.
L1_Receive[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_Receive[n]SettlementAmount
decimal
The amount of a settlement
L1_Receive[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_Receive[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_Receive[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_Receive[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_Receive[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_Receive[n]BankAccount
string
Example: 12345678
The account number of the bank
L1_Receive[n]BankSwift
string
Example: CAP123
The BIC of the bank
L1_Receive[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L1_Receive[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_Receive[n]BankAddress2
string
Example: The City
The second line of the bank's address
L1_Receive[n]BankAddress3
string
Example: London
The third line of the bank's address
L1_Receive[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_Receive[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_Receive[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_Receive[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_Receive[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_Receive[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L1_Receive[n]SplitComponentId
string
The unique ID of a split component
L1_Receive[n]SettlementDetailsLine1
string
The first line of remittance information.
L1_Receive[n]SettlementDetailsLine2
string
The second line of remittance information.
L1_Receive[n]SettlementDetailsLine3
string
The third line of remittance information.
L1_Receive[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L1_Receive[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L1_Receive[n]SettlementDetailsLine6
string
The sixth line of remittance information.
NettingComponents L1_PayNettingComponents[n]
API
L1_PayNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L1_PayNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_PayNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
NettingComponents L1_ReceiveNettingComponents[n]
API
L1_ReceiveNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L1_ReceiveNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_ReceiveNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
L1_CanAffirm
boolean
Ability to Affirm the Trade Details are as agreed.
L1_CanConfirm
boolean
Ability to Confirm the Settlement Details are now final.
L1_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L1_CanDispute
boolean
Ability to Dispute the details of a trade, if for example something is wrong about it.
L1_CanCancel
boolean
Ability to Cancel a trade, for example if a mistake was made.
L1_CanReplace
boolean
Ability to mark a deal as amended, meaning that it has been replaced by a corrected deal.
L1_CanAutoConfirm
boolean
Ability to Mark that the deal was Confirmed by the Bank, rather than by the client.
L1_CanUnconfirm
boolean
Ability to move the deal back to a Pending state.
L1_CanApproveInstructions
boolean
Can approve settlement instructions for a trade.
L1_CanRejectInstructions
boolean
Can reject settlement instructions for a trade.
L1_CanRelease
boolean
Relates to post trade actions: User can release the trade
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_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
L1_NextActionDeadlineDisplayTimezone
string
Example: America/New_York
The timezone for the NextActionDeadline field in the form Area/Location
L1_AffirmedBy
string
The name of the user who affirmed a trade.
L1_AffirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was affirmed in ISO-8601 format
L1_ConfirmedBy
string
The name of the user who confirmed a trade.
L1_ConfirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was confirmed in ISO-8601 format
L1_IsPayNetted
boolean
Denotes whether the pay side of a trade has been netted.
L1_IsReceiveNetted
boolean
Denotes whether the receive side of a trade has been netted.
L1_IsPayNettingRequired
boolean
Denotes whether the pay side of a trade requires netting.
L1_IsReceiveNettingRequired
boolean
Denotes whether the receive side of a trade requires netting.
L1_IsPaySplit
boolean
Denotes whether the pay side of a trade has been split.
L1_IsReceiveSplit
boolean
Denotes whether the receive side of a trade has been split.
NostroAccount L1
API
L1_NostroName
string
Example: GBP Nostro Account.
An identifier for the given nostro account.
L1_NostroBIC
string
Example: ARABAEADABC
The Bank Identifier Code denoting the bank which will receive the money.
L1_NostroAccount
string
Example: AE770090004000824676500
The account at the bank denoted by the NostroBIC field that will receive the money.
RemarksEntry L1_Remarks[n]
API
L1_Remarks[n]Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
L1_Remarks[n]RemarkDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The date and time a remark was left on in ISO-8601 format.
L1_Remarks[n]RemarkSource
string
The username of the person who left a remark on a trade.
L1_Remarks[n]RemarkOriginStatus
string
Additional remark field pointing at the previous status of the trade.
L1_Remarks[n]RemarkTargetStatus
string
Additional remark field pointing at the current status of the trade when the remark was added.
L1_TradeID
string
Example: 00001561
A unique identifier for this trade
L1_AllInRate
decimal
Example: 1.091790
L1_AllInRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
L1_AllInMidRate
decimal
Example: 1.091790
The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
L1_FwdPoints
decimal
Example: 0.001198
L1_FwdMidPoints
decimal
Example: 0.005390
The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.
L1_FwdPips
string
Example: 11.98
L1_BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_Amount
decimal
The amount of a trade or order in the DealtCurrency.
L1_ContraAmount
decimal
Example: 350
The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.
L1_Tenor
string
Example: 1M
Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.
L1_SettlementDate
string
L1_FilledAmount
decimal
Example: 0
L1_RemainingAmount
decimal
Example: 500
L1_RiskDate
string
Example: 20160314
The date in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_RiskTenor
string
Example: 1W
The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_StartDate
string
Example: 20150620
L1_StartTenor
string
Example: 1W
L1_IsTimeOption
boolean
Example: true
true if a leg is time-option
L1_Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
L1_Profit
decimal
Example: 1000
The sales profit in the specified currency.
L1_CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
L1_EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
L1_EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
L1_CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
L1_CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
L1_ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
L1_ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
L1_ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
L1_ServiceContraCostAmount
decimal
The actual service cost of performing the trade to the client on the contra currency
L1_ServiceContraCostCurrency
string
Example: GBP
The service contra currency that the cost is displayed in
L1_ServiceCostAmount
decimal
The actual service cost of performing the trade to the client on the home currency
L1_ServiceCostCurrency
string
Example: GBP
The service home currency that the cost is displayed in
L1_TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
L1_FullName
string
The full name of the user the trade is on behalf of
L1_ForwardPointsDecimalOffset
integer
Example: 4
Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.
L1_AllocatableAmount
decimal
Example: 500
This is the amount that can be allocated or rolled.
L1_AllocatableContraAmount
decimal
Example: 500
This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency
L1_OriginalRate
decimal
The Rate of the trade that this trade was created from.
L1_AdjustedSwapPoints
decimal
The swap points adjusted for this repriced trade
NDFLegTradeConfirmationFields L1
API
L1_FixingDate
string
Example: 20150620
This is the day and time whereby the comparison between the NDF rate and the prevailing spot rate is made.
L1_FixingCurrency
string
Example: USD
L1_FixingCode
string
Example: [CCY]1/1600/GBLO
L1_FixingDescription
string
Example: WMR [CCY] 4pm London
L1_FixingAmount
decimal
The Buy or Sell Amount from the original deal for currency that is the Settlement Currency
L1_ReferenceCurrency
decimal
The Buy or Sell Currency that is not the Settlement Currency
L1_ReferenceAmount
decimal
The Buy or Sell Amount from the original deal for currency that is not the Settlement Currency
L1_SettlementAmount
decimal
The amount of a settlement
TimeOptionLegTradeConfirmationFields L1
API
L1_FilledAmount
decimal
Example: 0
L1_RemainingAmount
decimal
Example: 500
L1_RiskDate
string
Example: 20160314
The date in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_RiskTenor
string
Example: 1W
The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_StartDate
string
Example: 20150620
L1_StartTenor
string
Example: 1W
This message has no fields that you can set.
This message has no fields that you can set.
SwapTradeBlotterRecord
Example
API
CommonBlotterFields
API
BaseCurrency
string
Example: USD
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
ExecutionStyle
string
The execution style. Caplin supported types are [ORDER, RFS, ESP]
USI
string
Unique swap identifier, global unique transaction identifier.
CommonSwapTradeConfirmation
Example
API
CommonTradeConfirmationFields
API
TradeID
string
Example: 00001561
A unique identifier for this trade
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
DealtCurrency
string
Example: GBP
The currency of the Amount of a trade or order.
SpotRate
decimal
Example: 1.08341
SpotMidRate
decimal
Example: 1.08345
The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
SpotRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
ExecutionDateTime
string
Example: 20160322123621
TradeDate
string
Example: 20160314
Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
TraderUsername
string
Example: sales_trader@novobank.co.za
The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.
TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
FullName
string
The full name of the user the trade is on behalf of
EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
string
Example: FX
A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
DeliverableType
string
Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)
DigitsBeforePips
integer
Example: 2
Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this field will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
NumberOfPips
integer
Example: 2
Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.
OrderID
string
The id of the order.
WarningCode
string
Example: 001
The code for the warning regarding a quote request.
WarningMessage
string
Example: **CREDIT CHECK:** This user has a credit limit of **1,000,000.00 USD** which should not be exceeded.
The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.
DetailedWarningMessage
string
Example: color: {{theme:foreground.semantic.warning_inverse}}
Client
string
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
CostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
ContraCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
ServiceCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
ServiceContraCostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
CanAllocate
string
Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL
CanDrawdown
boolean
Ability to Drawdown a time option trade.
AllocationSettlementDateOptions
string
Example: ORIGINAL,EARLIER,LATER
Comma-separated list, defines available settlement dates for an allocation.
IsAllocated
boolean
Deprecated, use HasPostTradeHistory instead.
HasPostTradeHistory
boolean
Define whether post-trade history (related deals e.g. drawdowns, allocations, early take ups and roll overs) is available.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
AmountDPS
integer
Example: 2
The precision for a specified currency pair and dealt currency
ContraAmountDPS
integer
Example: 2
The precision for a specified currency pair and contra currency
Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
UTI
string
Unique Transaction Identifier.
BackOfficeID
string
Back office trade identifier.
PriceSource
string
Example: st1@caplin.com
Identifies the person or system that priced the trade.
Venue
string
Example: FX Sales
Where the trade was placed.
Purpose
string
Example: Commercial
The purpose of a trade.
Tags
string
Example: method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}
Tags for a trade.
ClientAgreementDateTime
datetime
Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different
PostTradeType
string
The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION, DRAWDOWN
OriginalTradeID
string
TradeID of the trade that this trade was created from.
Status
string
Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.
NaturalLanguageSummaryHidden
boolean
When true, the natural language summary will be hidden on the RFS ticket summary.
IsCommercial
boolean
Indicates whether the given trade is commercial or not
NDFTradeConfirmationFields
API
FixingSource
string
Example: WMR 8am London Time
SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
LegTradeConfirmationFields L1
API
SettlementTradeFields L1
API
SettlementFields L1_Pay[n]
API
L1_Pay[n]SettlementId
string
The identifier for the settlement instruction.
L1_Pay[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_Pay[n]SettlementAmount
decimal
The amount of a settlement
L1_Pay[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_Pay[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_Pay[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_Pay[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_Pay[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_Pay[n]BankAccount
string
Example: 12345678
The account number of the bank
L1_Pay[n]BankSwift
string
Example: CAP123
The BIC of the bank
L1_Pay[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L1_Pay[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_Pay[n]BankAddress2
string
Example: The City
The second line of the bank's address
L1_Pay[n]BankAddress3
string
Example: London
The third line of the bank's address
L1_Pay[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_Pay[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_Pay[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_Pay[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_Pay[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_Pay[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L1_Pay[n]SplitComponentId
string
The unique ID of a split component
L1_Pay[n]SettlementDetailsLine1
string
The first line of remittance information.
L1_Pay[n]SettlementDetailsLine2
string
The second line of remittance information.
L1_Pay[n]SettlementDetailsLine3
string
The third line of remittance information.
L1_Pay[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L1_Pay[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L1_Pay[n]SettlementDetailsLine6
string
The sixth line of remittance information.
SettlementFields L1_Receive[n]
API
L1_Receive[n]SettlementId
string
The identifier for the settlement instruction.
L1_Receive[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_Receive[n]SettlementAmount
decimal
The amount of a settlement
L1_Receive[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_Receive[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_Receive[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_Receive[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_Receive[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_Receive[n]BankAccount
string
Example: 12345678
The account number of the bank
L1_Receive[n]BankSwift
string
Example: CAP123
The BIC of the bank
L1_Receive[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L1_Receive[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_Receive[n]BankAddress2
string
Example: The City
The second line of the bank's address
L1_Receive[n]BankAddress3
string
Example: London
The third line of the bank's address
L1_Receive[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_Receive[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_Receive[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_Receive[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_Receive[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_Receive[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L1_Receive[n]SplitComponentId
string
The unique ID of a split component
L1_Receive[n]SettlementDetailsLine1
string
The first line of remittance information.
L1_Receive[n]SettlementDetailsLine2
string
The second line of remittance information.
L1_Receive[n]SettlementDetailsLine3
string
The third line of remittance information.
L1_Receive[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L1_Receive[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L1_Receive[n]SettlementDetailsLine6
string
The sixth line of remittance information.
NettingComponents L1_PayNettingComponents[n]
API
L1_PayNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L1_PayNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_PayNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
NettingComponents L1_ReceiveNettingComponents[n]
API
L1_ReceiveNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L1_ReceiveNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_ReceiveNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
L1_CanAffirm
boolean
Ability to Affirm the Trade Details are as agreed.
L1_CanConfirm
boolean
Ability to Confirm the Settlement Details are now final.
L1_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L1_CanDispute
boolean
Ability to Dispute the details of a trade, if for example something is wrong about it.
L1_CanCancel
boolean
Ability to Cancel a trade, for example if a mistake was made.
L1_CanReplace
boolean
Ability to mark a deal as amended, meaning that it has been replaced by a corrected deal.
L1_CanAutoConfirm
boolean
Ability to Mark that the deal was Confirmed by the Bank, rather than by the client.
L1_CanUnconfirm
boolean
Ability to move the deal back to a Pending state.
L1_CanApproveInstructions
boolean
Can approve settlement instructions for a trade.
L1_CanRejectInstructions
boolean
Can reject settlement instructions for a trade.
L1_CanRelease
boolean
Relates to post trade actions: User can release the trade
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L1_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
L1_NextActionDeadlineDisplayTimezone
string
Example: America/New_York
The timezone for the NextActionDeadline field in the form Area/Location
L1_AffirmedBy
string
The name of the user who affirmed a trade.
L1_AffirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was affirmed in ISO-8601 format
L1_ConfirmedBy
string
The name of the user who confirmed a trade.
L1_ConfirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was confirmed in ISO-8601 format
L1_IsPayNetted
boolean
Denotes whether the pay side of a trade has been netted.
L1_IsReceiveNetted
boolean
Denotes whether the receive side of a trade has been netted.
L1_IsPayNettingRequired
boolean
Denotes whether the pay side of a trade requires netting.
L1_IsReceiveNettingRequired
boolean
Denotes whether the receive side of a trade requires netting.
L1_IsPaySplit
boolean
Denotes whether the pay side of a trade has been split.
L1_IsReceiveSplit
boolean
Denotes whether the receive side of a trade has been split.
NostroAccount L1
API
L1_NostroName
string
Example: GBP Nostro Account.
An identifier for the given nostro account.
L1_NostroBIC
string
Example: ARABAEADABC
The Bank Identifier Code denoting the bank which will receive the money.
L1_NostroAccount
string
Example: AE770090004000824676500
The account at the bank denoted by the NostroBIC field that will receive the money.
RemarksEntry L1_Remarks[n]
API
L1_Remarks[n]Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
L1_Remarks[n]RemarkDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The date and time a remark was left on in ISO-8601 format.
L1_Remarks[n]RemarkSource
string
The username of the person who left a remark on a trade.
L1_Remarks[n]RemarkOriginStatus
string
Additional remark field pointing at the previous status of the trade.
L1_Remarks[n]RemarkTargetStatus
string
Additional remark field pointing at the current status of the trade when the remark was added.
L1_TradeID
string
Example: 00001561
A unique identifier for this trade
L1_AllInRate
decimal
Example: 1.091790
L1_AllInRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
L1_AllInMidRate
decimal
Example: 1.091790
The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
L1_FwdPoints
decimal
Example: 0.001198
L1_FwdMidPoints
decimal
Example: 0.005390
The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.
L1_FwdPips
string
Example: 11.98
L1_BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L1_Amount
decimal
The amount of a trade or order in the DealtCurrency.
L1_ContraAmount
decimal
Example: 350
The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.
L1_Tenor
string
Example: 1M
Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.
L1_SettlementDate
string
L1_FilledAmount
decimal
Example: 0
L1_RemainingAmount
decimal
Example: 500
L1_RiskDate
string
Example: 20160314
The date in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_RiskTenor
string
Example: 1W
The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.
L1_StartDate
string
Example: 20150620
L1_StartTenor
string
Example: 1W
L1_IsTimeOption
boolean
Example: true
true if a leg is time-option
L1_Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
L1_Profit
decimal
Example: 1000
The sales profit in the specified currency.
L1_CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
L1_EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
L1_EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
L1_CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
L1_CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
L1_ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
L1_ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
L1_ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
L1_ServiceContraCostAmount
decimal
The actual service cost of performing the trade to the client on the contra currency
L1_ServiceContraCostCurrency
string
Example: GBP
The service contra currency that the cost is displayed in
L1_ServiceCostAmount
decimal
The actual service cost of performing the trade to the client on the home currency
L1_ServiceCostCurrency
string
Example: GBP
The service home currency that the cost is displayed in
L1_TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
L1_FullName
string
The full name of the user the trade is on behalf of
L1_ForwardPointsDecimalOffset
integer
Example: 4
Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.
L1_AllocatableAmount
decimal
Example: 500
This is the amount that can be allocated or rolled.
L1_AllocatableContraAmount
decimal
Example: 500
This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency
L1_OriginalRate
decimal
The Rate of the trade that this trade was created from.
L1_AdjustedSwapPoints
decimal
The swap points adjusted for this repriced trade
LegTradeConfirmationFields L2
API
SettlementTradeFields L2
API
SettlementFields L2_Pay[n]
API
L2_Pay[n]SettlementId
string
The identifier for the settlement instruction.
L2_Pay[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L2_Pay[n]SettlementAmount
decimal
The amount of a settlement
L2_Pay[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L2_Pay[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L2_Pay[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L2_Pay[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L2_Pay[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L2_Pay[n]BankAccount
string
Example: 12345678
The account number of the bank
L2_Pay[n]BankSwift
string
Example: CAP123
The BIC of the bank
L2_Pay[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L2_Pay[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L2_Pay[n]BankAddress2
string
Example: The City
The second line of the bank's address
L2_Pay[n]BankAddress3
string
Example: London
The third line of the bank's address
L2_Pay[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L2_Pay[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L2_Pay[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L2_Pay[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L2_Pay[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L2_Pay[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L2_Pay[n]SplitComponentId
string
The unique ID of a split component
L2_Pay[n]SettlementDetailsLine1
string
The first line of remittance information.
L2_Pay[n]SettlementDetailsLine2
string
The second line of remittance information.
L2_Pay[n]SettlementDetailsLine3
string
The third line of remittance information.
L2_Pay[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L2_Pay[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L2_Pay[n]SettlementDetailsLine6
string
The sixth line of remittance information.
SettlementFields L2_Receive[n]
API
L2_Receive[n]SettlementId
string
The identifier for the settlement instruction.
L2_Receive[n]SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L2_Receive[n]SettlementAmount
decimal
The amount of a settlement
L2_Receive[n]SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L2_Receive[n]IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L2_Receive[n]SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L2_Receive[n]SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L2_Receive[n]SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L2_Receive[n]BankAccount
string
Example: 12345678
The account number of the bank
L2_Receive[n]BankSwift
string
Example: CAP123
The BIC of the bank
L2_Receive[n]BankName
string
Example: Bank Of Caplin
The name of the bank
L2_Receive[n]BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L2_Receive[n]BankAddress2
string
Example: The City
The second line of the bank's address
L2_Receive[n]BankAddress3
string
Example: London
The third line of the bank's address
L2_Receive[n]IndividualAccount
string
Example: 87654321
The account number of the recipient
L2_Receive[n]IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L2_Receive[n]IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L2_Receive[n]IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L2_Receive[n]IndividualAddress2
string
Example: Manchester
The second line of the recipient
L2_Receive[n]NettingStatus
string
Example: NETTED
The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
L2_Receive[n]SplitComponentId
string
The unique ID of a split component
L2_Receive[n]SettlementDetailsLine1
string
The first line of remittance information.
L2_Receive[n]SettlementDetailsLine2
string
The second line of remittance information.
L2_Receive[n]SettlementDetailsLine3
string
The third line of remittance information.
L2_Receive[n]SettlementDetailsLine4
string
The fourth line of remittance information.
L2_Receive[n]SettlementDetailsLine5
string
The fifth line of remittance information.
L2_Receive[n]SettlementDetailsLine6
string
The sixth line of remittance information.
NettingComponents L2_PayNettingComponents[n]
API
L2_PayNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L2_PayNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L2_PayNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
NettingComponents L2_ReceiveNettingComponents[n]
API
L2_ReceiveNettingComponents[n]TradeID
string
Example: 00001561
A unique identifier for this trade
L2_ReceiveNettingComponents[n]BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L2_ReceiveNettingComponents[n]Amount
decimal
The amount of a trade or order in the DealtCurrency.
L2_CanAffirm
boolean
Ability to Affirm the Trade Details are as agreed.
L2_CanConfirm
boolean
Ability to Confirm the Settlement Details are now final.
L2_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L2_CanDispute
boolean
Ability to Dispute the details of a trade, if for example something is wrong about it.
L2_CanCancel
boolean
Ability to Cancel a trade, for example if a mistake was made.
L2_CanReplace
boolean
Ability to mark a deal as amended, meaning that it has been replaced by a corrected deal.
L2_CanAutoConfirm
boolean
Ability to Mark that the deal was Confirmed by the Bank, rather than by the client.
L2_CanUnconfirm
boolean
Ability to move the deal back to a Pending state.
L2_CanApproveInstructions
boolean
Can approve settlement instructions for a trade.
L2_CanRejectInstructions
boolean
Can reject settlement instructions for a trade.
L2_CanRelease
boolean
Relates to post trade actions: User can release the trade
L2_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
L2_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
L2_NextActionDeadlineDisplayTimezone
string
Example: America/New_York
The timezone for the NextActionDeadline field in the form Area/Location
L2_AffirmedBy
string
The name of the user who affirmed a trade.
L2_AffirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was affirmed in ISO-8601 format
L2_ConfirmedBy
string
The name of the user who confirmed a trade.
L2_ConfirmedDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The time at which a trade was confirmed in ISO-8601 format
L2_IsPayNetted
boolean
Denotes whether the pay side of a trade has been netted.
L2_IsReceiveNetted
boolean
Denotes whether the receive side of a trade has been netted.
L2_IsPayNettingRequired
boolean
Denotes whether the pay side of a trade requires netting.
L2_IsReceiveNettingRequired
boolean
Denotes whether the receive side of a trade requires netting.
L2_IsPaySplit
boolean
Denotes whether the pay side of a trade has been split.
L2_IsReceiveSplit
boolean
Denotes whether the receive side of a trade has been split.
NostroAccount L2
API
L2_NostroName
string
Example: GBP Nostro Account.
An identifier for the given nostro account.
L2_NostroBIC
string
Example: ARABAEADABC
The Bank Identifier Code denoting the bank which will receive the money.
L2_NostroAccount
string
Example: AE770090004000824676500
The account at the bank denoted by the NostroBIC field that will receive the money.
RemarksEntry L2_Remarks[n]
API
L2_Remarks[n]Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
L2_Remarks[n]RemarkDateTime
datetime
Example: 2018-03-16T07:25:16+00:00
The date and time a remark was left on in ISO-8601 format.
L2_Remarks[n]RemarkSource
string
The username of the person who left a remark on a trade.
L2_Remarks[n]RemarkOriginStatus
string
Additional remark field pointing at the previous status of the trade.
L2_Remarks[n]RemarkTargetStatus
string
Additional remark field pointing at the current status of the trade when the remark was added.
L2_TradeID
string
Example: 00001561
A unique identifier for this trade
L2_AllInRate
decimal
Example: 1.091790
L2_AllInRateDPS
integer
Example: 5
The number of decimal places to display after the decimal point.
L2_AllInMidRate
decimal
Example: 1.091790
The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.
L2_FwdPoints
decimal
Example: 0.001198
L2_FwdMidPoints
decimal
Example: 0.005390
The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.
L2_FwdPips
string
Example: 11.98
L2_BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
L2_Amount
decimal
The amount of a trade or order in the DealtCurrency.
L2_ContraAmount
decimal
Example: 350
The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.
L2_Tenor
string
Example: 1M
Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.
L2_SettlementDate
string
L2_FilledAmount
decimal
Example: 0
L2_RemainingAmount
decimal
Example: 500
L2_RiskDate
string
Example: 20160314
The date in the settlement window which yields the lowest client sell price, or the highest client buy price.
L2_RiskTenor
string
Example: 1W
The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.
L2_StartDate
string
Example: 20150620
L2_StartTenor
string
Example: 1W
L2_IsTimeOption
boolean
Example: true
true if a leg is time-option
L2_Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
L2_Profit
decimal
Example: 1000
The sales profit in the specified currency.
L2_CostAmount
decimal
Example: 12412891.31
The actual transactional cost of performing the trade to the client in the home currency
L2_EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
L2_EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
L2_CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
L2_CostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.
L2_ContraCostAmount
decimal
The actual transactional cost of performing the trade to the client on the contra currency
L2_ContraCostCurrency
string
Example: GBP
The contra currency that the cost is displayed in
L2_ContraCostPercentage
decimal
Example: 13.56
Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.
L2_ServiceContraCostAmount
decimal
The actual service cost of performing the trade to the client on the contra currency
L2_ServiceContraCostCurrency
string
Example: GBP
The service contra currency that the cost is displayed in
L2_ServiceCostAmount
decimal
The actual service cost of performing the trade to the client on the home currency
L2_ServiceCostCurrency
string
Example: GBP
The service home currency that the cost is displayed in
L2_TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
L2_FullName
string
The full name of the user the trade is on behalf of
L2_ForwardPointsDecimalOffset
integer
Example: 4
Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.
L2_AllocatableAmount
decimal
Example: 500
This is the amount that can be allocated or rolled.
L2_AllocatableContraAmount
decimal
Example: 500
This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency
L2_OriginalRate
decimal
The Rate of the trade that this trade was created from.
L2_AdjustedSwapPoints
decimal
The swap points adjusted for this repriced trade
NDFLegTradeConfirmationFields L1
API
L1_FixingDate
string
Example: 20150620
This is the day and time whereby the comparison between the NDF rate and the prevailing spot rate is made.
L1_FixingCurrency
string
Example: USD
L1_FixingCode
string
Example: [CCY]1/1600/GBLO
L1_FixingDescription
string
Example: WMR [CCY] 4pm London
L1_FixingAmount
decimal
The Buy or Sell Amount from the original deal for currency that is the Settlement Currency
L1_ReferenceCurrency
decimal
The Buy or Sell Currency that is not the Settlement Currency
L1_ReferenceAmount
decimal
The Buy or Sell Amount from the original deal for currency that is not the Settlement Currency
L1_SettlementAmount
decimal
The amount of a settlement
NDFLegTradeConfirmationFields L2
API
L2_FixingDate
string
Example: 20150620
This is the day and time whereby the comparison between the NDF rate and the prevailing spot rate is made.
L2_FixingCurrency
string
Example: USD
L2_FixingCode
string
Example: [CCY]1/1600/GBLO
L2_FixingDescription
string
Example: WMR [CCY] 4pm London
L2_FixingAmount
decimal
The Buy or Sell Amount from the original deal for currency that is the Settlement Currency
L2_ReferenceCurrency
decimal
The Buy or Sell Currency that is not the Settlement Currency
L2_ReferenceAmount
decimal
The Buy or Sell Amount from the original deal for currency that is not the Settlement Currency
L2_SettlementAmount
decimal
The amount of a settlement
SwapTradeConfirmationFields
API
SwapPoints
decimal
Example: 0.005390
The difference in interest rates between transaction currencies.
SwapMidPoints
decimal
Example: 0.004553
SwapPips
string
Example: 53.90
SwapType
string
Example: SPOTFWD
This message has no fields that you can set.
This message has no fields that you can set.

Order blotter record specification

FX Mobile supports blotter records built using the FX Integration API 3’s order blotter record builder.

FX Integration API version: 8.14.0.

OrderBlotterRecord
Example
API
CommonFields
API
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
Account
string
Example: Garfields|GARF
The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>
AllowedActions
string
Comma separated list of Caplin supported values [Edit, Deactivate, Cancel, Activate, InactiveEdit, InactiveDeactivate, InactiveCancel, InactiveActivate]
ActivationType
string
How the order should be activated. Caplin supported statuses are [GFA, EXPLICIT]
ActivationDateTime
datetime
Example: 2013-07-24T17:13:59.985
The time and date the order will become active. This is in ISO-8601 format.
ActivationDisplayTimeZone
timezone
Example: Europe/London
The timezone that the activation time and date should be formatted to for display. This is in the TZ database format.
ExpirationType
string
How the order should be deactivated. Caplin supported statuses are [IOC, GTC, GFD, FOK, EXPLICIT]
ExpirationDateTime
datetime
Example: 2013-07-24T17:13:59.985
The time and date the order will be deactivated. This is in ISO-8601 format.
ExpirationDisplayTimeZone
timezone
Example: Europe/London
The timezone that the expiration time and date should be formatted to for display. This is in the TZ database format.
AlertType
string
The type of alert that an order will send. Caplin supported statuses are [EMAIL, SMS].
StrategyID
string
The strategy Id of the order.
StrategyType
string
The strategy the order was submitted with. This field should not be used by the front end for structuring orders. Comma separated list of Caplin supported values are [SINGLE, IF-DONE-OCO, OCO, IF-DONE, IF-TIMEOUT, IF-DONE-LOOP, LOOP]. OTHER denotes a strategy type that is unsupported.
TraderUsername
string
Example: sales_trader@novobank.co.za
The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.
TOBOUser
string
Example: client@customer.co.za
The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.
FullName
string
The full name of the user the trade is on behalf of
EntityId
string
Example: CUSTONE
The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
OrderCount
integer
OrderID
string
The id of the order.
ActivationDate
string
What date the strategy should be activated.
ActivationTime
string
What time the strategy should be activated if the ActivationDate was in the format of yyyymmdd.
ActivationLocation
string
Example: Europe/London
When location should be used to evaluate the time to activate if the ActivationDate was in the format of yyyymmdd.
ActivationUTCOffset
string
ExpirationDate
string
What date the strategy should expire.
ExpirationTime
string
What time the strategy should be activated if the ExpirationDate was in the format of yyyymmdd.
ExpirationLocation
string
When location should be used to evaluate the time to expire if the ExpirationDate was in the format of yyyymmdd.
ExpirationUTCOffset
string
Temperature
string
Example: 2
Shows how close an Order is to its trigger point at the leg level. Shows the maximum of the leg temperatures at the common level [1=cold,2=warm,3=hot,4=very hot,5=target rate reached].
SubmittedDateTime
datetime
Example: 2023-04-19T11:09:45.00Z
The time and date a trade or order was submitted
FixingSource
string
Example: WMR 8am London Time
SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
LegFields
API
Editable
boolean
Whether a trade or order is editable.
OrderID
string
The id of the order.
Status
string
Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.
OrderStatus
string
Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, ACTIVE, PARENT-ACTIVE, PENDING-DEACTIVATION, DEACTIVATED, EXPIRED, COMPLETED, REJECTED, PENDING-CANCEL, CANCELLED, CANCELLED-BY-PARTNER]
SubmittedDateTime
datetime
Example: 2023-04-19T11:09:45.00Z
The time and date a trade or order was submitted
LastActionBy
string
The last person or system to perform an action on an order.
LastActionDateTime
datetime
The time and date of the last action on an order.
Amount
decimal
The amount of a trade or order in the DealtCurrency.
Filled
decimal
The amount of an order that has been filled.
Remaining
decimal
The amount of an order that has not been filled.
MonitorSide
string
The side that should be monitored for an order to be triggered.
DealtCurrency
string
Example: GBP
The currency of the Amount of a trade or order.
BuySell
string
The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.
ExecutionType
string
The order type. Caplin supported types are [BENCHMARK, CALL-ORDER, MARKET, PEGGED, STOP-LOSS, TAKE-PROFIT]
BenchmarkType
string
The benchmark order name. For example, ECB.
LimitPrice
decimal
The price at which a leg should fill.
Remarks
string
The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales
ChildLegId
integer
ChildRelationship
string
PartnerLegId
integer
PartnerRelationship
string
LoopLegId
integer
FillRate
string
OrderTenor
string
The tenor the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.
OrderSettlementDate
date
The settlement date the order will settle on for Forward and NDF orders. Either OrderTenor or OrderSettlementDate should be provided but not both.
OrderFixingDate
date
The date an NDF order will fix on if filled.
Temperature
string
Example: 2
Shows how close an Order is to its trigger point at the leg level. Shows the maximum of the leg temperatures at the common level [1=cold,2=warm,3=hot,4=very hot,5=target rate reached].
FilledRate
decimal
Example: 123.012345
The rate at which an order has been filled.
OrderType
string
Example: TAKE-PROFIT, STOP-LOSS
The order execution type. Caplin supported types are TAKE-PROFIT, STOP-LOSS, CALL-ORDER, MARKET, BENCHMARK, MARKET, PEGGED.
FillID
string
Example: 00001561
The Trade ID of the trade created when an order is fully filled by a single fill.
This message has no fields that you can set.