CME ClearPort API - Allocation Report Message - Outbound
/AllocRpt
Field Name | FIXML Attribute Name | Data Type | Description | Present / Conditional / Optional | Supported Values |
---|---|---|---|---|---|
Report ID |
| String | Unique identifier for this Allocation Report message. Generated by CME Clearing. | P | |
Message ID |
| String | Unique identifier for allocation message. Echoes back the value submitted on the Allocation Instruction. | P | |
Transaction Type |
| char | Used to express New, Cancel, or Replace. Only New and Cancel are supported. | P |
|
Report Type |
| int | Specifies the purpose or type of Allocation Report message. | P | 15 - Give-up |
Status |
| int | Identifies status of the allocation. | P |
|
Clear Date |
| LocalMktDate | The Clearing Date for the allocation. | O | |
Input Source |
| String | The original system from which the trade originated. Typically set to the Sender ID. | O | |
Quantity |
| Qty | Total quantity of the bunched order allocation. | P | |
Venue Type |
| char | Identifies the type of venue for the allocation. | P |
|
Transaction Time |
| UTCTimestamp | Date/time of the action performed on the allocation. | P | |
Risk Limit Check Status |
| int | Credit Pre-Approval Flag. Indicates the status of the risk limit check performed on the allocaton or the cleared bunched trade. | O | 13 - Accepted by execution venue |
Reference Risk Limit Check ID |
| String | A credit approval token can be assigned to allocations. This applies to all allocations listed in this message. | O | |
Offset Trade ID |
| String | Contains the Trade ID of the offset trade. Present when the offset has cleared. Note: This field will only be supported for IRS allocation offsets. | C | |
StandardHeader |
| ||||
→ Sender ID |
| String | This attribute identifies the party or the Submitter of the message. This is set to CME. | P | |
→ Target ID |
| String | This attribute identifies the receiver of the message. This must be set to CME. | P | |
→ Sender Qualifier |
| String | This attribute qualifies the Sender. The user ID assigned to the sender must be provided. | P | |
→ Target Qualifier |
| String | This qualifies the receiver of the message. For CME ClearPort Trade submission this must be set to CPAPI. | P | |
OrdAllocGrp (repeating) |
| ||||
→ Client Order ID |
| String | If provided, this field will be used on all offset Trade Capture Reports in the ClOrdID2 field. If this is not provided, then the original client order ID assigned for the original bunched order will be used on all offset Trade Capture Reports in the ClOrdID2 field. | O | |
→ Secondary Client Order ID |
| String | This is the ID assigned by the client for the bunched trade side. It appears on the Trade Capture Report of the bunched trade in ClOrdID. | O | |
ExecAllocGrp (repeating) |
| ||||
→ Execution ID |
| String | ClearPort assigned ExecID for the original bunched order. This is one of the identifiers that can be specified to locate the bunched order. Note: This field will not be supported for IRS allocation submission. | C | |
→ Secondary Execution ID |
| String | Platform assigned ExecID2 for the original bunched order. This is one of the identifiers that can be specified to locate the bunched order. Note: This field will not be supported for IRS allocation submission. | C | |
→ Trade ID |
| String | Trade ID assigned by CME Clearing for the bunched order. This is one of the identifiers that can be specified to locate the bunched order. Note: This field will only be supported for IRS allocation submission. | C | |
Instrument |
| ||||
→ Security Type |
| String | Indicates type of instrument or security being traded or defined. | P |
|
Parties (repeating) |
| ||||
→ Party ID |
| String | Used to identify the Asset Manager holding account. For IRS, only account aliases are supported. | P | |
→ Party ID Source |
| char | Used to identify class source of PartyID value. | P |
|
→ Party Role |
| int | Indicates the type of Party or the role of the party in the Party Block. | P |
|
→ PtysSubGrp (repeating) |
| ||||
→→ Party Qualifier ID |
| String | A Sub ID provides additional information about the Party. | O | |
→→ Party Qualifier Type |
| int | The Type of Party Sub ID in the Party Sub Tag. | O |
|
RegulatoryTradeIDGrp (repeating) |
| ||||
→ Regulatory Trade ID |
| String | Regulatory Trade ID. Will be used to communicate the Unique Transaction Identifier associated with a trade execution as required by the CFTC. This can contain the Unique Transaction Identifier (UTI) for the block (original bunched trade) if available. It will also communicate the bilateral (alpha) UTI for the bunched order. If a bilateral UTI is not specified inbound, then CME Clearing will assign one. | P | |
→ Regulatory Trade ID Source |
| String | With the conversion to Unique Transaction Identifier (UTI), this tag will be empty. | P | |
→ Regulatory Trade ID Event |
| int | Event causing origination of the ID. | P |
|
→ Regulatory Trade ID Type |
| int | The type of Regulatory Trade ID being sent. | P |
|
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.