CME GC Allocator API - Message Specification - Submit Collateral Allocation
Submit allocations of collateral.
URL |
|
---|---|
HTTP Method |
|
Version | 1.0.30 |
Content |
---|
Request
Parameters
Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
---|---|---|---|---|---|---|---|
| Application Name | Header |
| No | REQUIRED | Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly. | |
| Application Vendor | Header |
| No | REQUIRED | Name of the vendor who provided the customer system. For a proprietary system, use the firm name. | |
| Application Version | Header |
| No | REQUIRED | Version identifier for the customer system. | |
| Request ID | Header |
| No | REQUIRED | Identifier for the customer message. | |
| Transaction Time | Header |
| No | Format:Â | REQUIRED | Timestamp of when the message was sent from customer system. |
Body
Collateral Request Message - CollateralRequestMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Payload |
|
Collateral - CollateralRequestMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Quantity |
| REQUIRED | ||
| Side GUID |
| REQUIRED | ||
| Instrument |
|
Instrument - CollateralRequestMessage.payload[].instrument
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Cusip |
| CONDITIONAL | Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN. | |
| GUID |
| CONDITIONAL | Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN. | |
| ISIN |
| CONDITIONAL | Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN. |
Response - 200
Body
Collateral Response Message - CollateralResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Payload |
|
Collateral - CollateralResponseMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Collateral GUID |
| ALWAYS | Note: this is the GUID of the newly introduced collateral. | |
| Venue Collateral ID |
| ALWAYS | ||
Links |
|
Link - CollateralResponseMessage.payload[].links[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Reference |
| ALWAYS | ||
| Relationship Type |
| ALWAYS | Allocations will only result in a SELF link, while substitutions may include all four |
Response - 400
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
|
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Code |
| ALWAYS | ||
| Instance |
| OPTIONAL | ||
| Message |
| ALWAYS | ||
| Reference Index |
| ALWAYS |
Response - 401
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.