Page Comparison

Excerpt

hidden	false

Request a collateral allocation by its GUID. Results will be limited to active trades, and trades which have ended within the last 7 calendar days.

Panel

borderColor	lightgray

URL	`/collateral/{collateralGuid}`
HTTP Method	`GET`
Version	1.0.30

Panel

borderColor	lightgray
title	Content

Table of Contents

maxLevel	2

Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

CME-Application-Name

Application Name

Header

String

No

Status

subtle	true
colour	Green
title	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

Status

subtle	true
colour	Green
title	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

Status

subtle	true
colour	Green
title	REQUIRED

Version identifier for the customer system.

CME-Request-ID

Request ID

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Identifier for the customer message.

CME-Transact-Time

Transaction Time

Header

DateTime

No

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Grey
title	OPTIONAL

Timestamp of when the message was sent from customer system.

collateralGuid

Collateral GUID

Path

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Response - 200

Body

Anchor
Response200CollateralResponseMessage
Response200CollateralResponseMessage
Collateral Response Message - CollateralResponseMessage

Field	Name	Type	Values	Usage	Description
payload[]	Payload	Collateral

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

Field

Name

Type

Values

Usage

Description

accruedInterestAmt

Accrued Interest Amount

Decimal

Status

subtle	true
colour	Blue
title	CONDITIONAL

Always when Status = SUBSTITUTED

cleanPrice

Clean Price

Price

Status

subtle	true
colour	Green
title	ALWAYS

collateralGuid

Collateral GUID

String

Status

subtle	true
colour	Green
title	ALWAYS

dealId

Deal ID

String

Status

subtle	true
colour	Green
title	ALWAYS

dirtyPrice

Dirty Price

Price

Status

subtle	true
colour	Green
title	ALWAYS

endCash

End Cash

Decimal

Status

subtle	true
colour	Blue
title	CONDITIONAL

Not present for EONIA repos.

lastUpdateTime

Last Update Time

DateTime

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Green
title	ALWAYS

notificationQty

Notification Quantity

Integer

Status

subtle	true
colour	Blue
title	CONDITIONAL

Aggregate quantity of all remaining, unfilled notifications on this allocation

Always when NotificationQuantity <> 0

originalCollateralGuid

Original Collateral GUID

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Always when SubstitutionIndicator = SUBSTITUTION
Always when SubstitutionIndicator = REMAINDER

originalTransactionTime

Original Transaction Time

DateTime

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Green
title	ALWAYS

originalVenueCollateralNbr

Original Venue Collateral Number

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Always when SubstitutionIndicator = SUBSTITUTION
Always when SubstitutionIndicator = REMAINDER

qty

Quantity

Status

subtle	true
colour	Green
title	ALWAYS

sideGuid

Side GUID

String

Status

subtle	true
colour	Green
title	ALWAYS

sideInd

Side Indicator

MarketSideIndicator

BUY
SELL

Status

subtle	true
colour	Green
title	ALWAYS

startCash

Start Cash

Decimal

Status

subtle	true
colour	Green
title	ALWAYS

status

Collateral Status

CollateralStatus

ACTIVE
CANCELED
SUBSTITUTED

Status

subtle	true
colour	Green
title	ALWAYS

substitutionInd

Substitution Indicator

SubstitutionIndicator

ORIGINAL
REMAINDER
SUBSTITUTION

Status

subtle	true
colour	Green
title	ALWAYS

substitutionsRemainingCnt

Substitutions Remaining Count

Integer

Status

subtle	true
colour	Green
title	ALWAYS

tradeId

Trade ID

String

Status

subtle	true
colour	Green
title	ALWAYS

transactionTime

Transaction Time

DateTime

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Green
title	ALWAYS

venueCollateralNbr

Venue Collateral ID

String

Status

subtle	true
colour	Green
title	ALWAYS

entities

Entities

TradeSideEntities

generalCollateralInstrument

General Collateral Instrument

Instrument

instrument

Instrument

Anchor
Response200CollateralResponseMessage.payload[].entities
Response200CollateralResponseMessage.payload[].entities
Trade Side Entities - `CollateralResponseMessage.payload[].entities`

Field

Name

Type

Values

Usage

Description

enteringTraderId

Entering Trader ID

String

Status

subtle	true
colour	Green
title	ALWAYS

executingFirmId

Executing Firm ID

String

Status

subtle	true
colour	Green
title	ALWAYS

oppositeFirmId

Opposite Firm ID

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Always when BilateralIndicator = YES

Anchor
Response200CollateralResponseMessage.payload[].generalCollateralInstrument
Response200CollateralResponseMessage.payload[].generalCollateralInstrument
Instrument - `CollateralResponseMessage.payload[].generalCollateralInstrument`

Field

Name

Type

Values

Usage

Description

clearingOrganizationId

Clearing Organization ID

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Always when BilateralIndicator = NO

cusip

CUSIP

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Only present on US securities.

exchangeId

Exchange ID

String

Status

subtle	true
colour	Green
title	ALWAYS

guid

GUID

String

Status

subtle	true
colour	Green
title	ALWAYS

isin

ISIN

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Only present on non-US securities.

longName

LongName

String

Status

subtle	true
colour	Green
title	ALWAYS

priceSource

Price Source

PriceSource

CLEAN
DIRTY

Status

subtle	true
colour	Green
title	ALWAYS

Price applied for the cash flow valuation

symbol

Symbol

String

Status

subtle	true
colour	Green
title	ALWAYS

Anchor
Response200CollateralResponseMessage.payload[].instrument
Response200CollateralResponseMessage.payload[].instrument
Instrument - CollateralResponseMessage.payload[].instrument

Field

Name

Type

Values

Usage

Description

cusip

CUSIP

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Only present on US securities.

guid

GUID

String

Status

subtle	true
colour	Green
title	ALWAYS

isin

ISIN

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Only present on non-US securities.

longName

Long Name

String

Status

subtle	true
colour	Green
title	ALWAYS

productType

Product Type

ProductType

BOND
EUSOV
EUSUP
TB
TBA
TINT
TIPS
SOV
SUPRA
TBILL
TBOND
TNOTE

Status

subtle	true
colour	Green
title	ALWAYS

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

Response - 200

Body

AnchorResponse200CollateralResponseMessageResponse200CollateralResponseMessageCollateral Response Message - CollateralResponseMessage

Field

Name

Type

Values

Usage

Description

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

Field

Name

Type

Values

Usage

Description

AnchorResponse200CollateralResponseMessage.payload[].entitiesResponse200CollateralResponseMessage.payload[].entitiesTrade Side Entities - CollateralResponseMessage.payload[].entities

Field

Name

Type

Values

Usage

Description

AnchorResponse200CollateralResponseMessage.payload[].generalCollateralInstrumentResponse200CollateralResponseMessage.payload[].generalCollateralInstrumentInstrument - CollateralResponseMessage.payload[].generalCollateralInstrument

Field

Name

Type

Values

Usage

Description

AnchorResponse200CollateralResponseMessage.payload[].instrumentResponse200CollateralResponseMessage.payload[].instrumentInstrument - CollateralResponseMessage.payload[].instrument

Field

Name

Type

Values

Usage

Description

Response - 401

Response - 404

Anchor
Response200CollateralResponseMessage
Response200CollateralResponseMessage
Collateral Response Message - CollateralResponseMessage

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

Anchor
Response200CollateralResponseMessage.payload[].entities
Response200CollateralResponseMessage.payload[].entities
Trade Side Entities - `CollateralResponseMessage.payload[].entities`

Anchor
Response200CollateralResponseMessage.payload[].generalCollateralInstrument
Response200CollateralResponseMessage.payload[].generalCollateralInstrument
Instrument - `CollateralResponseMessage.payload[].generalCollateralInstrument`

Anchor
Response200CollateralResponseMessage.payload[].instrument
Response200CollateralResponseMessage.payload[].instrument
Instrument - CollateralResponseMessage.payload[].instrument