Collateral Inquiry

Application Management

Beyond order routing, the T4 FIX API provides additional functionalities to query and manage positions, orders, and accounts. The Collateral Inquiry message (MsgType=BB) is the cornerstone of (non-routing) application management. If successful, Collateral Inquiries result in responses from the T4 FIX API server with Execution Reports, Collateral Reports, or Security Definitions.

Driven by its Subscription Request Type (Tag 263), the Collateral Inquiry can provide the following functionalities:

Subscribe to multiple accounts for the connected user

Unsubscribe from multiple accounts for the connected user

List User Accounts

List History of a specific order

List Orders of a specific account

List User Information

After FIX logon success, the CTS API system requires subscription to user accounts before any orders can be placed. This is a key requirement.

By default, all user accounts are automatically subscribed to on login. However, this can be disabled with Tag 372=BB in the Logon message. In that case, subscriptions must be made explicitly using a Collateral Inquiry.

To list accounts, send a Collateral Inquiry with:

Tag 263=0 (Snapshot)

Tag 896=0 (Customer-Accounts)

Responses are returned as multiple Collateral Reports with:

Account Name in Tag 1

Account ID in Tag 448

To subscribe to accounts:

Tag 263=1 (Snapshot Plus Updates)

Tag 896=0 (Customer-Accounts)

Use PartyID repeating group with:

Tag 452=24 (Customer-Account)

Tag 448 = list of Account IDs

Subscriptions are performed by Account ID (Tag 448), not Account Name.

A successful subscription returns:

Account State (margins, balances, PnL)

Account Portfolio (orders, fills, positions)

You can suppress these by:

Setting Tag 725=1 (Out-Of-Band)

Or setting Tag 372=d in Logon

To re-trigger reports, unsubscribe then re-subscribe to the same account.

Send a Collateral Inquiry with:

Tag 263=2 (Disable Previous Snapshot Plus Update)

Tag 896=0 (Customer-Accounts)

PartyID group with:

Tag 452=24

Tag 448 = Account IDs

No response is returned for unsubscribe.

To get order history:

Tag 263=0 (Snapshot)

Tag 896=3 (Order-History)

Use PartyID group:

Tag 452=3 (Order-Id)

Tag 448 = Order ID(s)

Responses return multiple Execution Reports showing all stages of the order.

To list orders/fills for an account:

Tag 263=0 (Snapshot)

Tag 896=4 or other appropriate CollInquiryQualifier

Use PartyID group:

Tag 452=24 (Customer-Account)

Tag 448 = Account IDs

Responses return Execution Reports for all order statuses (working, filled, rejected, etc.).

Tag 97=Y (PossResend) flags them as inquiry responses

Tag 584 (MassStatusReqID) matches to Tag 909 (CollInquiryID)

To differentiate fills:

Fills contain Tag 31 (LastPx) and Tag 32 (LastQty)

To list trader/user information:

Tag 896=13 (User/Trader Information)

Optional PartyID group:

Tag 452=24 (Customer_Account)

Tag 452=22 (User_Exchanges)

PartyID Tag 448 may be:

A specific username (Tag 553)

The string “Traders” for all logged-in traders

Response (Collateral Report with Tag 854=8) includes:

User name, unique ID, type, firm, parent firm, roles

Assigned accounts and enabled exchanges (if requested)

0 = Snapshot \ 1 = Snapshot Plus Updates (Subscribe) \ 2 = Disable Previous Snapshot Plus Updates (Unsubscribe) |

0 = In Band (Default) \ 1 = Out of Band |

PartyID Repeating Group:

22 = User Exchanges \ 24 = Customer Account \ 3 = Order Id |

CollInquiryQualifier Repeating Group:

0 = Customer Accounts \ 1 = Customer Exchanges \ 3 = Order History \ 4 = Account Orders – All \ 5 = Account Orders – Working \ 6 = Account Orders – Canceled \ 7 = Account Orders – Filled \ 8 = Account Orders – Rejected \ 9 = Account Orders – Suspended \ 11 = Account Fills \ 12 = Account Overnights \ 13 = User/Trader Information |