Margin Service API - Transaction - Get

Description

The request allows the Client to retrieve the contents of a transaction which was already added to CORE (Add Transaction and Update Transaction). The must submit the unique CORE-assigned internal transaction identifier in the request URL. If the requested transaction does not exist with the identifier or if the client is not authorized to get the transaction then an error is returned. The server will return the requested transaction to the Client if valid and if the transaction is found.  

Request

Parameter

Name

Type

Required

Notes

Parameter

Name

Type

Required

Notes

encoding

Encoding

Transaction Encoding

No

Defaults to STRING

reqUserId

Requesting User ID

String

No

 

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@createTime

Create Time

Date/Time

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@updateTime

Update Time

Date/Time 

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

403

Returned if the user does not have permission to access the specified portfolio.

404

Returned if the requested transaction could not be found.

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/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>  </transactionRpt>



How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.