Margin Service API - Transaction - List

Parameter

Name

Type

Required

Notes

Parameter

Name

Type

Required

Notes

encoding

Encoding

Transaction Encoding

No

Defaults to STRING

portfolioId

Portfolio ID

String

Yes



reqUserId

Requesting User ID

String

No



valid

Valid

Boolean

No

If specified, limits the request to valid (if true) or invalid (if false) transactions. If not specified, both are returned.

Response

XPath

Name

Type

Required

Notes

XPath

Name

Type

Required

Notes

/transactionRpt/error@code

Error Code

String

No



/transactionRpt/error@msg

Error Message

String

No



/transactionRpt/transaction@id

ID

String

Yes



/transactionRpt/transaction@portfolioId

Portfolio ID

String

Yes



/transactionRpt/transaction@status

Status

Entity Status

Yes



/transactionRpt/transaction@type

Transaction Type

Transaction Type  

Yes



/transactionRpt/transaction/payload@encoding

Payload Encoding

Transaction Encoding

Yes



/transactionRpt/transaction/payload@format

Payload Format

Transaction Format

Yes



/transactionRpt/transaction/payload/string

String Payload

String

No



Errors

Code

Description

Code

Description

500

The server was not able to process the request. More information (if available) will be provided in the error message.

Examples

Basic
Request
GET /transactions?portfolioId=123&encoding=STRING
Response
<transactionRpt> <transaction id="123" portfolioId="1234" status="UPDATED" type="TRADE"> <payload encoding="STRING" format="FIXML"> <string><![CDATA[<FIXML><!-- TrdCaptRpt goes here --></FIXML>]]></string> </payload> </transaction>  <transaction id="234" portfolioId="1234" status="ERROR" type="TRADE"> <payload encoding="STRING" format="FIXML"> <string><![CDATA[<FIXML><!-- TrdCaptRpt goes here --></FIXML>]]></string> </payload> </transaction> </transactionRpt>
Query for Invalid Transactions
Request
GET /transactions?portfolioId=123&encoding=STRING&valid=false
Response



How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.