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:

SpotBlotterRecord
CommonBlotterFields
BaseCurrency
string
Example: USD
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, SWAP, TIME_OPTION]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
Status
string
Use OrderStatus instead.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
SpotTradeConfirmation
CommonTradeConfirmationFields
TradeID
string
Example: 00001561
A unique identifier for this trade
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
DealtCurrency
string
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.
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.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
string
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, SWAP, TIME_OPTION]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
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 bla 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: You do not have sufficient credit for EUR
The message to display for any warnings regarding a quote request
Client
string
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The total transactional cost of performing the trade to the client
CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the Term Currency
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%.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
CostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
Remarks
string
The clients or trader's comments on an order leg - visible to both the Client and the Trader
LegTradeConfirmationFields L1
SettlementTradeFields L1
SettlementFields L1
L1_SettlementId
string
The identifier for the trade.
L1_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_SettlementAmount
decimal
The amount of a settlement
L1_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L1_BankAccount
string
Example: 12345678
The account number of the bank
L1_BankSwift
string
Example: CAP123
The BIC of the bank
L1_BankName
string
Example: Bank Of Caplin
The name of the bank
L1_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_BankAddress2
string
Example: The City
The second line of the bank's address
L1_BankAddress3
string
Example: London
The third line of the bank's address
L1_IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_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_SplitComponentId
string
The unique ID of a split component
L1_SettlementDetailsLine1
string
The first line of remittance information.
L1_SettlementDetailsLine2
string
The second line of remittance information.
L1_SettlementDetailsLine3
string
The third line of remittance information.
L1_SettlementDetailsLine4
string
The fourth line of remittance information.
SettlementFields L1
L1_SettlementId
string
The identifier for the trade.
L1_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_SettlementAmount
decimal
The amount of a settlement
L1_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L1_BankAccount
string
Example: 12345678
The account number of the bank
L1_BankSwift
string
Example: CAP123
The BIC of the bank
L1_BankName
string
Example: Bank Of Caplin
The name of the bank
L1_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_BankAddress2
string
Example: The City
The second line of the bank's address
L1_BankAddress3
string
Example: London
The third line of the bank's address
L1_IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_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_SplitComponentId
string
The unique ID of a split component
L1_SettlementDetailsLine1
string
The first line of remittance information.
L1_SettlementDetailsLine2
string
The second line of remittance information.
L1_SettlementDetailsLine3
string
The third line of remittance information.
L1_SettlementDetailsLine4
string
The fourth line of remittance information.
L1_CanAffirm
boolean
Can affirm settlement instructions for a trade.
L1_CanConfirm
boolean
Can confirm settlement instructions for a trade.
L1_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, 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_AllInRate
decimal
Example: 1.091790
L1_AllInRateDPS
integer
Example: 5
L1_AllInMidRate
decimal
Example: 1.091790
L1_FwdPoints
decimal
Example: 0.001198
L1_FwdMidPoints
decimal
Example: 0.005390
L1_FwdPips
string
Example: 11.98
L1_BuySell
string
The direction of the trade or trade leg. 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 a SettlementDate must be sent
L1_SettlementDate
string
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 total transactional cost of performing the trade to the client
ForwardBlotterRecord
CommonBlotterFields
BaseCurrency
string
Example: USD
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, SWAP, TIME_OPTION]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
Status
string
Use OrderStatus instead.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
ForwardTradeConfirmation
CommonTradeConfirmationFields
TradeID
string
Example: 00001561
A unique identifier for this trade
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
DealtCurrency
string
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.
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.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
string
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, SWAP, TIME_OPTION]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
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 bla 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: You do not have sufficient credit for EUR
The message to display for any warnings regarding a quote request
Client
string
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The total transactional cost of performing the trade to the client
CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the Term Currency
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%.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
CostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
Remarks
string
The clients or trader's comments on an order leg - visible to both the Client and the Trader
LegTradeConfirmationFields L1
SettlementTradeFields L1
SettlementFields L1
L1_SettlementId
string
The identifier for the trade.
L1_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_SettlementAmount
decimal
The amount of a settlement
L1_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L1_BankAccount
string
Example: 12345678
The account number of the bank
L1_BankSwift
string
Example: CAP123
The BIC of the bank
L1_BankName
string
Example: Bank Of Caplin
The name of the bank
L1_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_BankAddress2
string
Example: The City
The second line of the bank's address
L1_BankAddress3
string
Example: London
The third line of the bank's address
L1_IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_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_SplitComponentId
string
The unique ID of a split component
L1_SettlementDetailsLine1
string
The first line of remittance information.
L1_SettlementDetailsLine2
string
The second line of remittance information.
L1_SettlementDetailsLine3
string
The third line of remittance information.
L1_SettlementDetailsLine4
string
The fourth line of remittance information.
SettlementFields L1
L1_SettlementId
string
The identifier for the trade.
L1_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_SettlementAmount
decimal
The amount of a settlement
L1_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L1_BankAccount
string
Example: 12345678
The account number of the bank
L1_BankSwift
string
Example: CAP123
The BIC of the bank
L1_BankName
string
Example: Bank Of Caplin
The name of the bank
L1_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_BankAddress2
string
Example: The City
The second line of the bank's address
L1_BankAddress3
string
Example: London
The third line of the bank's address
L1_IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_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_SplitComponentId
string
The unique ID of a split component
L1_SettlementDetailsLine1
string
The first line of remittance information.
L1_SettlementDetailsLine2
string
The second line of remittance information.
L1_SettlementDetailsLine3
string
The third line of remittance information.
L1_SettlementDetailsLine4
string
The fourth line of remittance information.
L1_CanAffirm
boolean
Can affirm settlement instructions for a trade.
L1_CanConfirm
boolean
Can confirm settlement instructions for a trade.
L1_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, 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_AllInRate
decimal
Example: 1.091790
L1_AllInRateDPS
integer
Example: 5
L1_AllInMidRate
decimal
Example: 1.091790
L1_FwdPoints
decimal
Example: 0.001198
L1_FwdMidPoints
decimal
Example: 0.005390
L1_FwdPips
string
Example: 11.98
L1_BuySell
string
The direction of the trade or trade leg. 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 a SettlementDate must be sent
L1_SettlementDate
string
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 total transactional cost of performing the trade to the client
NDFLegTradeConfirmationFields L1
L1_FixingDate
string
Example: 20150620
L1_FixingCurrency
string
Example: USD
L1_FixingCode
string
Example: [CCY]1/1600/GBLO
L1_FixingDescription
string
Example: WMR [CCY] 4pm London
TimeOptionLegTradeConfirmationFields L1
L1_FilledAmount
decimal
Example: 0
L1_RemainingAmount
decimal
Example: 500
L1_RiskDate
string
Example: 20160314
L1_RiskTenor
string
Example: 1W
L1_StartDate
string
Example: 20150620
L1_StartTenor
string
Example: 1W
SwapTradeBlotterRecord
CommonBlotterFields
BaseCurrency
string
Example: USD
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, SWAP, TIME_OPTION]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
Status
string
Use OrderStatus instead.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
SwapTradeConfirmation
CommonTradeConfirmationFields
TradeID
string
Example: 00001561
A unique identifier for this trade
CurrencyPair
string
The currency pair for the trade. For example, EURUSD
DealtCurrency
string
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.
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.
EntityDescription
string
Example: Customer 1
The description of a trade on behalf of entity.
AssetType
string
TradingType
string
Caplin supported values are [SPOT, FWD, NDF, SWAP, TIME_OPTION]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.
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 bla 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: You do not have sufficient credit for EUR
The message to display for any warnings regarding a quote request
Client
string
Client is a duplicate of TOBOUser
CostAmount
decimal
Example: 12412891.31
The total transactional cost of performing the trade to the client
CostCurrency
string
Example: GBP
The currency that the cost is displayed in, this could be any currency but will typically be set to the Term Currency
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%.
IsReversible
boolean
Whether a trade can be reversed.
IsAmendable
boolean
Whether a trade can be amended.
IsCancellable
boolean
Whether a trade can be cancelled.
CostCurrencyDPS
integer
Example: 2
The number of decimal places to display after the decimal point.
Remarks
string
The clients or trader's comments on an order leg - visible to both the Client and the Trader
LegTradeConfirmationFields L1
SettlementTradeFields L1
SettlementFields L1
L1_SettlementId
string
The identifier for the trade.
L1_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_SettlementAmount
decimal
The amount of a settlement
L1_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L1_BankAccount
string
Example: 12345678
The account number of the bank
L1_BankSwift
string
Example: CAP123
The BIC of the bank
L1_BankName
string
Example: Bank Of Caplin
The name of the bank
L1_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_BankAddress2
string
Example: The City
The second line of the bank's address
L1_BankAddress3
string
Example: London
The third line of the bank's address
L1_IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_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_SplitComponentId
string
The unique ID of a split component
L1_SettlementDetailsLine1
string
The first line of remittance information.
L1_SettlementDetailsLine2
string
The second line of remittance information.
L1_SettlementDetailsLine3
string
The third line of remittance information.
L1_SettlementDetailsLine4
string
The fourth line of remittance information.
SettlementFields L1
L1_SettlementId
string
The identifier for the trade.
L1_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L1_SettlementAmount
decimal
The amount of a settlement
L1_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L1_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L1_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L1_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L1_BankAccount
string
Example: 12345678
The account number of the bank
L1_BankSwift
string
Example: CAP123
The BIC of the bank
L1_BankName
string
Example: Bank Of Caplin
The name of the bank
L1_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L1_BankAddress2
string
Example: The City
The second line of the bank's address
L1_BankAddress3
string
Example: London
The third line of the bank's address
L1_IndividualAccount
string
Example: 87654321
The account number of the recipient
L1_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L1_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L1_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L1_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L1_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_SplitComponentId
string
The unique ID of a split component
L1_SettlementDetailsLine1
string
The first line of remittance information.
L1_SettlementDetailsLine2
string
The second line of remittance information.
L1_SettlementDetailsLine3
string
The third line of remittance information.
L1_SettlementDetailsLine4
string
The fourth line of remittance information.
L1_CanAffirm
boolean
Can affirm settlement instructions for a trade.
L1_CanConfirm
boolean
Can confirm settlement instructions for a trade.
L1_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L1_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, 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_AllInRate
decimal
Example: 1.091790
L1_AllInRateDPS
integer
Example: 5
L1_AllInMidRate
decimal
Example: 1.091790
L1_FwdPoints
decimal
Example: 0.001198
L1_FwdMidPoints
decimal
Example: 0.005390
L1_FwdPips
string
Example: 11.98
L1_BuySell
string
The direction of the trade or trade leg. 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 a SettlementDate must be sent
L1_SettlementDate
string
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 total transactional cost of performing the trade to the client
LegTradeConfirmationFields L2
SettlementTradeFields L2
SettlementFields L2
L2_SettlementId
string
The identifier for the trade.
L2_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L2_SettlementAmount
decimal
The amount of a settlement
L2_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L2_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L2_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L2_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L2_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L2_BankAccount
string
Example: 12345678
The account number of the bank
L2_BankSwift
string
Example: CAP123
The BIC of the bank
L2_BankName
string
Example: Bank Of Caplin
The name of the bank
L2_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L2_BankAddress2
string
Example: The City
The second line of the bank's address
L2_BankAddress3
string
Example: London
The third line of the bank's address
L2_IndividualAccount
string
Example: 87654321
The account number of the recipient
L2_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L2_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L2_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L2_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L2_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_SplitComponentId
string
The unique ID of a split component
L2_SettlementDetailsLine1
string
The first line of remittance information.
L2_SettlementDetailsLine2
string
The second line of remittance information.
L2_SettlementDetailsLine3
string
The third line of remittance information.
L2_SettlementDetailsLine4
string
The fourth line of remittance information.
SettlementFields L2
L2_SettlementId
string
The identifier for the trade.
L2_SettlementCurrency
string
Example: GBP
A currency for of settlement instruction
L2_SettlementAmount
decimal
The amount of a settlement
L2_SettlementDirection
string
The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
L2_IsDefaultSettlementInstruction
boolean
Is this the default settlement instruction for this currency
L2_SettlementInstructionType
string
Example: EXISTING
The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
L2_SettlementDisplayName
string
Example: [CCY] Account 1
The name of the settlement instruction. This field can be omitted.
L2_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, OVERDUE, REJECTED]
L2_BankAccount
string
Example: 12345678
The account number of the bank
L2_BankSwift
string
Example: CAP123
The BIC of the bank
L2_BankName
string
Example: Bank Of Caplin
The name of the bank
L2_BankAddress1
string
Example: 12 Capitol
The first line of the bank's address
L2_BankAddress2
string
Example: The City
The second line of the bank's address
L2_BankAddress3
string
Example: London
The third line of the bank's address
L2_IndividualAccount
string
Example: 87654321
The account number of the recipient
L2_IndividualSwift
string
Example: SOLD987
The BIC of the recipient's account
L2_IndividualName
string
Example: Susan Sellers
The name of the payee or payee's bank
L2_IndividualAddress1
string
Example: 98 Lane
The first line of the recipient
L2_IndividualAddress2
string
Example: Manchester
The second line of the recipient
L2_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_SplitComponentId
string
The unique ID of a split component
L2_SettlementDetailsLine1
string
The first line of remittance information.
L2_SettlementDetailsLine2
string
The second line of remittance information.
L2_SettlementDetailsLine3
string
The third line of remittance information.
L2_SettlementDetailsLine4
string
The fourth line of remittance information.
L2_CanAffirm
boolean
Can affirm settlement instructions for a trade.
L2_CanConfirm
boolean
Can confirm settlement instructions for a trade.
L2_CanAdHoc
boolean
Can confirm adhoc settlement instructions for a trade.
L2_SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, 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_AllInRate
decimal
Example: 1.091790
L2_AllInRateDPS
integer
Example: 5
L2_AllInMidRate
decimal
Example: 1.091790
L2_FwdPoints
decimal
Example: 0.001198
L2_FwdMidPoints
decimal
Example: 0.005390
L2_FwdPips
string
Example: 11.98
L2_BuySell
string
The direction of the trade or trade leg. 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 a SettlementDate must be sent
L2_SettlementDate
string
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 total transactional cost of performing the trade to the client
SwapTradeConfirmationFields
SwapPoints
decimal
Example: 0.005390
SwapMidPoints
decimal
Example: 0.004553
SwapPips
string
Example: 53.90
SwapType
string
Example: SPOTFWD

Order blotter record specification

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

OrderBlotterRecord
CommonFields
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].
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.
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 [1=cold,2=warm,3=hot,4=very hot,5=target rate reached].
LegFields
Editable
boolean
Whether a trade or order is editable.
OrderID
string
The id of the order.
Status
string
Use OrderStatus instead.
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
The time and date a trade 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
The currency of the Amount of a trade or order.
BuySell
string
The direction of the trade or trade leg. 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 clients or trader's comments on an order leg - visible to both the Client and the Trader
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.