Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddenfalse

Submit allocations of collateral.

Panel
borderColorlightgray
URL/collateral
HTTP MethodPOST
Version1.0.30
Panel
borderColorlightgray
titleContent
Table of Contents
maxLevel2




Request

Parameters

ParameterNameLocationType
Multi-ple
MultipleValuesUsageDescription
CME-Application-NameApplication NameHeader StringNo
Status
subtletrue
colourGreen
titleREQUIRED

Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly.

CME-Application-VendorApplication VendorHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Name of the vendor who provided the customer system. For a proprietary system, use the firm name.

CME-Application-VersionApplication VersionHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Version identifier for the customer system.

CME-Request-IDRequest IDHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Identifier for the customer message.

CME-Transact-TimeTransaction TimeHeaderDateTime NoFormat:  yyyy-mm-ddThh:mm:ss.dZ
Status
subtletrue
colourGreen
titleREQUIRED

Timestamp of when the message was sent from customer system.

Body

Anchor
RequestCollateralRequestMessage
RequestCollateralRequestMessage
Collateral Request Message - CollateralRequestMessage

FieldNameTypeValuesUsageDescription
payload[]PayloadCollateral


Anchor
RequestCollateralRequestMessage.payload[]
RequestCollateralRequestMessage.payload[]
Collateral - CollateralRequestMessage.payload[]

FieldNameTypeValuesUsageDescription
qtyQuantityQuantity
Status
subtletrue
colourGreen
titleREQUIRED

sideGuidSide GUIDString
Status
subtletrue
colourGreen
titleREQUIRED

instrumentInstrumentInstrument


Anchor
RequestCollateralRequestMessage.payload[].instrument
RequestCollateralRequestMessage.payload[].instrument
Instrument - CollateralRequestMessage.payload[].instrument

FieldNameTypeValuesUsageDescription
cusipCusipString
Status
subtletrue
colourBlue
titleCONDITIONAL


Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN.


guidGUIDString
Status
subtletrue
colourBlue
titleCONDITIONAL


Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN.


isinISINString
Status
subtletrue
colourBlue
titleCONDITIONAL


Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN.


Response - 200

Body

Anchor
Response200CollateralResponseMessage
Response200CollateralResponseMessage
Collateral Response Message - CollateralResponseMessage

FieldNameTypeValuesUsageDescription
payload[]PayloadCollateral


Anchor
Response200CollateralResponseMessage.payload[]
Response200CollateralResponseMessage.payload[]
Collateral - CollateralResponseMessage.payload[]

FieldNameTypeValuesUsageDescription
collateralGuidCollateral GUIDString


Status
subtletrue
colourGreen
titleALWAYS


Note: this is the GUID of the newly introduced collateral.


venueCollateralNbrVenue Collateral IDString


Status
subtletrue
colourGreen
titleALWAYS

links[]LinksLink


FieldNameTypeValuesUsageDescription
hrefReferenceURI


Status
subtletrue
colourGreen
titleALWAYS

relRelationship TypeLinkRelationshipType
  • ORIGINAL_ALLOCATION
  • REMAINING_ALLOCATION
  • SELF
  • SUBSTITUTION
Status
subtletrue
colourGreen
titleALWAYS


Allocations will only result in a SELF link, while substitutions may include all four


Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - ErrorResponseMessage

Field Name Type Values Usage Description
errors[]ErrorsError

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - ErrorResponseMessage.errors[]

FieldNameTypeValuesUsageDescription
codeCodeString


Status
subtletrue
colourGreen
titleALWAYS

instanceInstanceString


Status
subtletrue
colourGrey
titleOPTIONAL

messageMessageString


Status
subtletrue
colourGreen
titleALWAYS

referenceIndexReference IndexInteger


Status
subtletrue
colourGreen
titleALWAYS

Response - 401