Order Blotter API

Test this service via Swagger: https://app.swaggerhub.com/apis-docs/Synnetra4/FXWebAPISOA/1.7

During implementation we provide dedicated Swagger documentation pointing to the Sandbox environment of the customer

For architecture overview check:

REST API for SOAClient facing REST API

/FXWebAPI/OrderBlotter

POST https://demo.fxcib.com/api/FXWebAPI/OrderBlotter

This service is able to respond with a deal order blotter data. It return active/cancelled and done orders. It can be used as client facing service after Oauth2 authentication or service behind firewall used by SOA

Request Body

Name
Type
Description

key

string

Customer Session Key or FXWebAPI key used by SOA

requestId

string

Unique requestID. Max 25 signs (for GUID - encode GUID as a base64 string)

customerCode

string

Code of particular customer. Customer mapping should be done on a bank side. In our Swagger Demo please use: SYNNETRA.HTML.TEST

dateStart

string

Filter parameter: Start Date

dateEnd

string

Filter parameter: End Date

currency

string

Currency Code ISO 4217 standard

amount

number

Amount value for Amount filter (works with comparisonSign)

comparisonSign

string

1 = amounts smaller than, 2 = amounts bigger than

[
  {
    "ExecutionTimeStamp": "2017-03-15T09:52:31.2255385",
    "Status": "Expired",
    "OrderId": 1,
    "UserId": "SYNNETRA.HTML.TEST",
    "Currency": "EUR",
    "OrderType": "Limit",
    "SideInfo": "I BUY EUR / SELL USD",
    "Side": "Buy",
    "CurrencyPair": "EUR/USD",
    "Amount": 434,
    "Price": 44,
    "SettlementDate": "2017-03-17T00:00:00",
    "ExpireTime": "17/03/2017 16:00:00",
    "TimeInForce": "\u0000",
    "Id": 1,
    "CompanyCode": "SYNNETRA.HTML.TEST",
    "QuoteReqIDvalue": "96b49ed2-c97c-4c7d-b2ea-849c06e643f6"
  },
  {
    "ExecutionTimeStamp": "2017-04-19T09:18:56.320989",
    "Status": "Expired",
    "OrderId": 3,
    "UserId": "SYNNETRA.HTML.TEST",
    "Currency": "EUR",
    "OrderType": "Limit",
    "SideInfo": "I BUY EUR / SELL USD",
    "Side": "Buy",
    "CurrencyPair": "EUR/USD",
    "Amount": 321,
    "Price": 22,
    "SettlementDate": "2017-04-21T00:00:00",
    "ExpireTime": "21/04/2017 16:00:00",
    "TimeInForce": "\u0000",
    "Id": 3,
    "CompanyCode": "SYNNETRA.HTML.TEST",
    "QuoteReqIDvalue": "aa070472-027e-4da1-82cf-503c53eab11d"
  }
]

Example:

{
  "requestId": "5n7658m6v45c4v",
  "customerCode": "SYNNETRA.HTML.TEST",
  "request": {
    "key": "X445Acg7tkxsy7HfZKHgDUKxKW9g4RWazM9NtjWTwdU6nxtQGKgKTMNmSdDcPECHGpvz3PnNVDH4H2Mq"
  },
  "filters": {
    "dateStart": "/Date(1057141987904)/",
    "dateEnd": "/Date(1557141987904)/",
    "currency": "EUR",
    "amount": 2134,
    "comparisonSign": 1
  }
}

Last updated