This is an old revision of the document!
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 the requests are 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
Listing User Accounts
After FIX logon success, the CTS API system requires subscription to user accounts before any orders can be placed. This is a key requirement without which no order would be accepted during the FIX Session. By default, all user accounts are automatically subscribed to upon a successful login.
If only a subset of user accounts is required for trading, Automatic Account Subscription can be disabled in the Logon message using Tag 372=BB. Subsequently, account subscriptions must be explicitly requested with the Collateral Inquiry message.
To request a list of user accounts:
- Use Tag 263=0 (Snapshot request)
- Set Tag 896=0 (Collateral Inquiry Qualifier = Customer-Accounts)
The response will be a series of Collateral Reports containing Account Name (Tag 1) and Account ID (Tag 448).
Account Subscriptions
To subscribe to accounts:
- Set Tag 263=1 (Snapshot + Updates)
- Use PartyID group with:
- Tag 452=24 (Customer-Account)
- Tag 448 set to desired Account IDs
- Set Tag 896=0 (Customer-Accounts)
A successful subscription loads the requested accounts and may return:
- Account State (details, balances, P/L, etc.)
- Account Portfolio (orders, fills, positions)
To suppress report traffic:
- Set Tag 725=1 (Out-Of-Band)
- Or in Logon message, set Tag 372=d to avoid echo of portfolio details
Note:
- Duplicate subscription attempts result in no response
- Refresh state using unsubscribe → subscribe
- Default auto-subscription on login unless Tag 372=BB is used
Unsubscribing From Accounts
To unsubscribe:
- Set Tag 263=2
- Use PartyID group:
- Tag 452=24 (Customer-Account)
- Tag 448 with Account IDs
- Set Tag 896=0
No response is returned for successful unsubscriptions.
Listing Order History
To request order history:
- Set Tag 263=0
- Set Tag 896=3 (Order-History)
- Include OrderID (Tag 37) as PartyID (Tag 448)
- Use Tag 452=3 (Order-ID)
Returns multiple Execution Reports showing all stages (e.g. risk approval, submission, exchange acknowledgment).
Listing Account Orders and Fills
To list orders/fills for an account:
- Set Tag 263=0
- Set Tag 896=4 (Account-Orders)
- Include AccountID in Tag 448
- Use Tag 452=24
Returns Execution Reports with working, filled, rejected, suspended states, etc.
Special tags:
- Tag 97=Y: PossResend
- Tag 584: MassStatusReqID (matches Tag 909 of request)
- Tags 31 and 32 (LastPx and LastQty) differentiate fills
Listing User/Trader Information
Set Tag 896=13 to request information on current traders logged into the FIX session.
Returns Collateral Reports with:
- User Name
- Unique ID
- Type
- Firm Name
- Parent Firm
- Roles
Optional fields (if requested):
- Assigned Accounts → Tag 452=24
- Enabled Exchanges → Tag 452=22
Request data for all users with PartyID=Traders, or for a specific user by setting Tag 553 (UserName from Trader Logon).