Request
Parameters
| Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
|---|---|---|---|---|---|---|---|
CME-Application-Name | Application Name | Header | String | No | REQUIRED | Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly. | |
CME-Application-Vendor | Application Vendor | Header | String | No | REQUIRED | Name of the vendor who provided the customer system. For a proprietary system, use the firm name. | |
CME-Application-Version | Application Version | Header | String | No | REQUIRED | Version identifier for the customer system. | |
CME-Request-ID | Request ID | Header | String | No | REQUIRED | Identifier for the customer message. | |
CME-Transact-Time | Transaction Time | Header | DateTime | No | Format: yyyy-mm-ddThh:mm:ss.dZ | REQUIRED | Timestamp of when the message was sent from customer system. |
Body
Collateral Request Message - CollateralRequestMessage
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
payload[] | Payload | Collateral |
Collateral - CollateralRequestMessage.payload[]
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
notificationGuid | Notification GUID | String | REQUIRED | ||
qty | Quantity | Quantity | REQUIRED | ||
instrument | Instrument | Instrument |
Instrument - CollateralRequestMessage.payload[].instrument
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
cusip | Cusip | String | CONDITIONAL | Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN. | |
guid | GUID | String | CONDITIONAL | Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN. | |
isin | ISIN | String | 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[]
| Payload | Collateral |
Collateral - CollateralResponseMessage.payload[]
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
collateralGuid | Collateral GUID | String | ALWAYS | Note: this is the GUID of the newly introduced collateral. | |
venueCollateralNbr | Venue Collateral ID | String | ALWAYS | ||
links[]
| Links | Link |
Link - CollateralResponseMessage.payload[].links[]
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
href | Reference | URI | ALWAYS | ||
rel | Relationship Type |
LinkRelationshipType
|
| 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[]
| Errors | Error |
Error - ErrorResponseMessage.errors[]
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
code | Code | String | ALWAYS | ||
instance | Instance | String | OPTIONAL | ||
message | Message | String | ALWAYS | ||
referenceIndex | Reference Index | Integer | ALWAYS |