Temenos Digital
R24 AMR | Min(s) read

WealthOrder

Name Description Introduced In
getInstrumentList This API retrieves the list of instruments based on the search value. 2021.04
getInstrumentMinimal This API retrieves the data for the instrument. 2021.04
getInstrumentDetails This API retrieves the details of the specified instrument. 2021.04
getStockNews This API retrieves the stock news for the specified RIC code of the instrument. 2021.04
getCurrencyGraph This API retrieves the historical data for the specified duration. 2021.04
getPricingData This API retrieves the pricing data for the specified instrument. 2021.04
getInstrumentTransactions This API retrieves the list of instruments based on the search value. 2021.07
createSecurityOrder This API places a new order of the selected type such as Market, Limit, Stop Loss, and Stop Limit. 2021.04
modifySecurityOrder This API modifies the existing order. 2021.04
cancelSecurityOrder This API cancels the order that is placed for either buying or selling. 2021.04
getCurrencyList This API retrieves the list of currencies. 2021.04
getMarketRates This API retrieves the market rates for the currency pairs. 2021.04
getWatchlistDB This API retrieves the favorite instruments of the user. 2021.04
updateWatchlistDB This API updates the favorite instruments of the user. 2021.04
createCurrencyOrder This API creates a forex order. 2021.04
getNewsDetails This API retrieves the stock news headlines and details. 2021.04
getNewsStory This API retrieves the news story for the given news ID. 2021.04
getSearchFavoriteInstruments This API retrieves the list of the instruments. 2023.01
getProductDetailsFromId This API retreives the instrument details of a particular instrument. 2022.01
generatePDF This API used to generate base64 for download functionality 2021.04
getFavoriteInstruments This API retrieves list of watchlisted instruments 2021.04
getProductDetails This API retrieves the instrument data from market providers 2021.04
getProductDetailsFromId This API retrieves the instrument data and its asset details. 2022.01
Object Data Models This Object Data Model describes the parameter name and other attribute details for WealthOrder.  

In the UI field mapping, the "Value only displayed in UI" is the actual output value. The UI field name is not displayed

 
Description: This API retrieves the list of instruments based on the search value.
Method: GET
URL: /services/data/v1/WealthOrder/operations/InstrumentDetails/getInstrumentList
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

portfolioId (Mandatory)

Specifies the ID field of the customer’s portfolio

searchByInstrumentName (Mandatory)

Specifies the value on which the search needs to be performed

sortBy (Mandatory)

Specifies the field on which the sort needs to be performed

{
    "portfolioId": "100273-1",
    "sortBy": "description",
    "searchByInstrumentName": "Amazon"
}
Response:

Parameters

/instrumentList (Mandatory)

Specifies the JSON array that contains the list of instruments

/instrumentId (Mandatory)

Specifies the unique ID of the instrument

/RICCode (Mandatory)

Specifies the RIC code of the instrument

/description (Mandatory)

Specifies the name of the instrument

/ISIN (Mandatory)

Specifies the ISIN code of the instrument

/holdingsType (Mandatory)

Specifies the stock exchange

    "opstatus_getSearchInstrumentList": 0,

    "opstatus_getSynonyms": 0,

    "opstatus": 0,

    "instrumentList": [{

            "instrumentId": "100027-000",

            "RICCode": "GOOGL.OQ",

            "description": "Google LLC",

            "ISIN": "US02079K1079",

            "holdingsType": "MKT_NYSE"

        }

    ],

    "httpStatusCode": 200,

    "status": "success"

}

Parameters

/instrumentList (Mandatory)

Specifies the JSON array that contains the list of instruments

/instrumentId (Mandatory)

Specifies the unique ID of the instrument

/RICCode (Mandatory)

Specifies the RIC code of the instrument

/description (Mandatory)

Specifies the name of the instrument

/ISIN (Mandatory)

Specifies the ISIN code of the instrument

/holdingsType (Mandatory)

Specifies the stock exchange



{
   
    "opstatus_getSearchInstrumentList": 0,

    "opstatus": 0,

    "instrumentList": [

        {

            "instrumentId": "480480-004",

            "RICCode": "",

            "description": "Amazon Equity Fund",

            "ISIN": "",

            "holdingsType": "NYSE"

        },

   ],

    "httpStatusCode": "200",

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Transact
  • Wealth Front Office (FO)
Enterprise API:

Transact:

  • getSearchInstrumentList: v1.0.0/reference/instruments?instrumentName=$instrumentName
  • getDXMasterAssetTypes:

    • v1.1.0/reference/instruments/derivativeContractMaster?$param=$instrumentId

 Wealth Front Office (FO):
  • getSearchInstrumentList: v1.0.0/reference/instruments?searchPattern=$instrumentName
  • getSynonyms: v1.0.0/reference/synonyms?objectId=$id

Field Mapping

UI Field Experience API Field Wealth FO  API Field Transact  API Field
Instrument Name (Not displayed in UI) Description Name InstrumentName
ISIN (Not displayed in UI) ISIN ExtIsInSynC ISIN
Exchange (Not displayed in UI) HoldingsType MarketThirdCode StockExchange
NA InstrumentID Code InstrumentID
NA RICCode Code AlternateInstrumentID
 
Description: This API retrieves the data for the instrument.
Method: GET
URL: services/data/v1/WealthOrder/operations/InstrumentDetails/getInstrumentMinimal
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

instrumentId (Mandatory)

Specifies the list of the instrument IDs. 

{
    "instrumentId": "100046-000"
}
Response:

Parameters

/country (Mandatory)

The country which the stock belongs to.

/region (Mandatory)

Specifies the instrument domicile

/assetType (Mandatory)

The type of the asset class that the instrument belong to.

/isSecurityAsset (Mandatory)

Specifies whether the instrument is a securities type of an asset

/interestRate (Mandatory)

Specifies the interest rate of the asset instrument

/duration (Mandatory)

The total duration or tenure of the instrument. The tenure of the bond is from the Issue date till the Maturity date.

/maturityDate (Mandatory)

The date in which the bond matures.

/rating (Mandatory)

Specifies the rating of the asset instrument

/nxtCouponDate (Mandatory)

The date in which the next coupon/interest is paid to the bond holders.

/modifiedDuration (Mandatory)

This specifies the change in the value of a security based on the change in interest rates

/type (Mandatory)

This specifies the type of the fund, whether it is a normal fund or Exchange Traded Fund (ETF)

/sector (Mandatory)

Specifies the industry

/issuer (Mandatory)

This specifies who issues the instrument.

/expiryDate (Mandatory)

This specifies the expiry date of the contract.

/contractSize (Mandatory)

This specifies the quantity and in multiples thereof in which the transactions can be executed.

/underlying (Mandatory)

Underlying are the financial assets based on which the derivatives' price is determined.

/optionStyle (Mandatory)

This specifies the style of an option (American or European etc..)

/optionClass (Mandatory)

This specifies the option class (Call or Put)

/strikePrice (Mandatory)

This specifies the price at which the options can be exercised.

{

//Stock

  "instrumentAssets": {
"assetTypes": {
"country": "USA",
"region": "North America",
"sector": "Communication Equipment",
"assetType": "Stock"
},
"isSecurityAsset": true
},

//Bond

    "instrumentAssets": {
"assetTypes": {
"interestRate": "0.72",
"duration": "3 Yrs",
"maturityDate": "04/27/2022",
"rating": "BB",
"nxtCoupnDate": "04/27/2022",
"modifiedDuration": "3 Yrs",
"assetType": "Bond"
},
"isSecurityAsset": true
},

//Fund

"instrumentAssets": {
"assetTypes": {
"country": "USA",
"region": "North America",
"type": "ETF",
"sector": "Large Cap",
"issuer": "Vanguard",
"assetType": "Fund"
},
"isSecurityAsset": true
},

 

//Future

"instrumentAssets": {
"assetTypes": {
"expiryDate": "07/16/2021",
"contractSize": "100",
"underlying": "Cisco Systems, Inc.",
"assetType": "Future"
},
"isSecurityAsset": false
},

 

//Option

 "instrumentAssets": {
"assetTypes": {
"expiryDate": "07/16/2021",
"optionStyle": "American",
"optionClass": "Call",
"contractSize": "100",
"underlying": "Apple Inc",
"strikePrice": "115",
"assetType": "Option"
},
"isSecurityAsset": false
},

 

//Forwards

"instrumentAssets": {
"assetTypes": {
"maturityDate": "01/21/2022",
"assetType": "Forward"
},
"isSecurityAsset": false
},

//Money Market

"instrumentAssets": {
"assetTypes": {
"interestRate": "4.75",
"contractType": "Term Deposit",
"maturityDate": "07/31/2021",
"assetType": "Money Market"
},
"isSecurityAsset": false
},

    "instrumentMinimal": [

        {

            "stockExchange": "NYSE",

            "lastPriceDate": "15 Apr 2021",

            "instrumentName": "Amazon.com",

            "priceCurrency": "USD",

            "quantity": "100",

            "ISINCode": "US0231351067",

            "instrumentId": "100046-000",

            "RICCode": "AMZN.O",

            "instrumentCurrencyId": "USD",

            "lastPrice": "3434.33"

        }

    ],

    "opstatus": 0,

    "opstatus_getInstrumentMinimal": 0,

    "httpStatusCode": 200,

    "status": "success"

}

Parameters

/country (Mandatory)

The country which the stock belongs to.

/region (Mandatory)

Specifies the instrument domicile

/assetType (Mandatory)

The type of the asset class that the instrument belong to.

/isSecurityAsset (Mandatory)

Specifies whether the instrument is a securities type of an asset

/interestRate (Mandatory)

Specifies the interest rate of the asset instrument

/duration (Mandatory)

The total duration or tenure of the instrument. The tenure of the bond is from the Issue date till the Maturity date.

/maturityDate (Mandatory)

The date in which the bond matures.

/rating (Mandatory)

Specifies the rating of the asset instrument

/nxtCouponDate (Mandatory)

The date in which the next coupon/interest is paid to the bond holders.

/modifiedDuration (Mandatory)

This specifies the change in the value of a security based on the change in interest rates

/type (Mandatory)

This specifies the type of the fund, whether it is a normal fund or Exchange Traded Fund (ETF)

/sector (Mandatory)

Specifies the industry

/issuer (Mandatory)

This specifies who issues the instrument.

/expiryDate (Mandatory)

This specifies the expiry date of the contract.

/contractSize (Mandatory)

This specifies the quantity and in multiples thereof in which the transactions can be executed.

/underlying (Mandatory)

Underlying are the financial assets based on which the derivatives' price is determined.

/optionStyle (Mandatory)

This specifies the style of an option (American or European etc..)

/optionClass (Mandatory)

This specifies the option class (Call or Put)

/strikePrice (Mandatory)

This specifies the price at which the options can be exercised.

/contractType (Mandatory)

Specifies the contract type of the asset instrument

 

{


//Stock

  "instrumentAssets": {
"assetTypes": {
"country": "USA",
"region": "North America",
"sector": "Communication Equipment",
"assetType": "Stock"
},
"isSecurityAsset": true
},

//Bond

    "instrumentAssets": {
"assetTypes": {
"interestRate": "0.72",
"duration": "3 Yrs",
"maturityDate": "04/27/2022",
"rating": "BB",
"nxtCoupnDate": "04/27/2022",
"modifiedDuration": "3 Yrs",
"assetType": "Bond"
},
"isSecurityAsset": true
},

//Fund

"instrumentAssets": {
"assetTypes": {
"country": "USA",
"region": "North America",
"type": "ETF",
"sector": "Large Cap",
"issuer": "Vanguard",
"assetType": "Fund"
},
"isSecurityAsset": true
},

 

//Future

"instrumentAssets": {
"assetTypes": {
"expiryDate": "07/16/2021",
"contractSize": "100",
"underlying": "Cisco Systems, Inc.",
"assetType": "Future"
},
"isSecurityAsset": false
},

 

//Option

 "instrumentAssets": {
"assetTypes": {
"expiryDate": "07/16/2021",
"optionStyle": "American",
"optionClass": "Call",
"contractSize": "100",
"underlying": "Apple Inc",
"strikePrice": "115",
"assetType": "Option"
},
"isSecurityAsset": false
},

 

//Forwards

"instrumentAssets": {
"assetTypes": {
"maturityDate": "01/21/2022",
"assetType": "Forward"
},
"isSecurityAsset": false
},

//Money Market

"instrumentAssets": {
"assetTypes": {
"interestRate": "4.75",
"contractType": "Term Deposit",
"maturityDate": "07/31/2021",
"assetType": "Money Market"
},
"isSecurityAsset": false
},

    "instrumentMinimal": [

        {

            "stockExchange": "NYSE",

            "lastPriceDate": "15 Apr 2021",

            "instrumentName": "Amazon.com",

            "priceCurrency": "USD",

            "quantity": "100",

            "ISINCode": "US0231351067",

            "instrumentId": "100046-000",

            "RICCode": "AMZN.O",

            "instrumentCurrencyId": "USD",

            "lastPrice": "3434.33"

        }

    ],

    "opstatus": 0,

    "opstatus_getInstrumentMinimal": 0,

    "httpStatusCode": 200,

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider:
  • Transact
  • Wealth Front Office (FO)
Enterprise API:
Transact:
  • getInstrumentMinimal: {base_url}/ v1.0.0/reference/instruments?instrumentId=$instrumentId
  • getSCAssetTypes: v1.1.0/reference/instruments?instrumentId=$instrumentId
  • getDXAssetTypes:v1.1.0/reference/instruments/derivativeInstrument?$param=$instrumentId
  • getDXMasterAssetTypes:v1.1.0/reference/instruments/derivativeContractMaster?$param=$instrumentId
 Wealth Front Office (FO):
  • getInstrumentMinimal: v1.0.0/reference/instruments/$instrumentId
  • getSynonyms:v1.0.0/reference/synonyms?objectId=$id

Field Mapping

UI Field Experience API Field Wealth FO API Field
Exchange ( Value only displayed in UI) StockExchange MarketThirdCodeange
NA InstrumentID Code
ISIN (Value only displayed in UI) ISINCode ExtIsInSynC
Last Updated On LastPriceDate  
Instrument Name InstrumentName Name
Instrument Currency Symbol PriceCurrency RefCurrCode
Quantity (Current Position Card) Quantity  
Instrument Curency Symbol InstrumentCurrencyID RefCurrCode
Last Price (Value displayed in UI) LastPrice ExtLastPriceN
NA RICCode Code
Region Region Region
Next Coupon Date NxtCoupnDate FirstCoupD
Interest Rate InterestRate InterestRateP
Maturity Date, Expiry Date MaturityDate,ExpiryDate EndD
Duration  Duration ExtDuration
Rating Rating ExtRatingC
Issuer Issuer IssuerThirdDenom
Type Type TypeName
Underlying Underlying UnderlyInstrDenom
Contract Size ContractSize ContractSizeN
Contract Type ContractType ContractTypeName
Strike Price StrikePrice ExerQuoteN
Country Country TaxGeoCode
Sector Sector ExtSectorDenom
Option Style OptionStyle OptStyleE
Option Class OptionClass OptionClassE
 
Description: This API retrieves the details of the specified instrument.
Method: GET
URL: /services/data/v1/WealthOrder/operations/InstrumentDetails/getInstrumentDetails
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

RICCode (Mandatory)

Specifies the RIC code of the instrument 

 {
 
 	"RICCode": "AMZN.O"
 	
 }
Response:

Refinitiv:

 

Parameters

/instrumentName (Mandatory)

Specifies the name of the instrument

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/ISINCode (Mandatory)

Specifies the ISIN code of the instrument

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/netChange (Mandatory)

Specifies the difference between the closing price of a prior trading period and the current trading period of an instrument.

/percentageChange (Mandatory)

Specifies the percentage change in the latest trade price or value from the historic close

/dateReceived (Mandatory)

Specifies the date on which the price has been updated

/timeReceived (Mandatory)

Species the time at which the price has been updated

/exchange (Mandatory)

Specifies the stock exchange

/lastPrice (Mandatory)

Specifies the last trade price or value

{

    "opstatus_getInstruments": 0,

    "instrumentDetails": {

        "instrumentName": "AMAZON COM",

        "referenceCurrency": "USD",

        "ISINCode": "US0231351067",

        "closeRate": "3478.05",

        "netchange": "14.93",

        "percentageChange": "0.43",

        "dateReceived": "03 Sep 2021",

        "timeReceived": "20:00:00",

        "exchange": "NSQ",

        "lastPrice": "3478.05"

    },

    "opstatus": 0,

    "httpStatusCode": "200"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider: Refinitiv
Enterprise API: getInstruments: Quotes/Quotes.svc/REST/Quotes_1/RetrieveItem_3

 

Fields: "CF_CURRENCY:CF_EXCHNG:ISIN_CODE:CF_NAME:TRDPRC_1:PCTCHNG: CF_CLOSE:CF_NETCHNG:CF_DATE:CF_TIME"

Field Mapping

UI field Experience API field Refinitiv  API field
ISIN (Value only displayed in UI)  ISINCode  ISIN_CODE
Instrument Name (Value only displayed in UI)  InstrumentName  CF_NAME
Exchange (Value only displayed in UI) Exchange CF_EXCHNG
Currency Symbol (Value only displayed in UI) ReferenceCurrency CF_CURRENCY
Price (Value only displayed in UI) LastPrice TRDPRC_1
NetChange (Value only displayed in UI) NetChange CF_NETCHNG
Percentage Change (Value only displayed in UI) PercentageChange PCTCHNG
Last Updated on DateReceived CF_DATE
Last Updated on TimeReceived CF_TIME
Price (Value only displayed in UI) CloseRate CF_CLOSE
 
Description: This API retrieves the stock news for the specified RIC code of the instrument.
Method: GET
URL: services/data/v1/WealthOrder/operations/InstrumentDetails/getStockNews
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

RICCode (Mandatory)

Specifies the RIC code of the instrument

pageSize (Optional)

Specifies the field on which the pagination needs to be performed

pageOffset (Optional)

Specifies the value on which the pagination needs to be performed

{

    "RICCode": "AMZN.O",

    "pageSize": 4,

    "pageOffset": 0

}
Response:

Refinitiv:

 

Parameters

/ST (Mandatory)

Specifies the status

/RT (Mandatory)

Specifies the news item revision item

/PR (Mandatory)

Specifies the news item provider

/LN (Mandatory)

Specifies the 2 letter language code

/TY (Mandatory)

Specifies the type such as Story, Alert, and Both

/LT (Mandatory)

Specifies the local time

/HT (Mandatory)

Specifies the news item headline

/CO (Mandatory)

Specifies the companies RICs

/CT (Mandatory)

Specifies the news item creation time

/RE (Mandatory)

Specifies the news item revision number

/AT (Mandatory)

Specifies the news attribution

/PD (Mandatory)

Specifies the products

/PE (Mandatory)

Specifies the PE values that can be multi-valued

/TN (Mandatory)

Specifies the Take Number to denote if a story is related to it exists

/ID (Mandatory)

Specifies the global unique ID

/TO (Mandatory)

Specifies the topics

/NI (Mandatory)

Specifies the named items

/UR (Mandatory)

Specifies the news item urgency

/totalCount (Mandatory)

Specifies the total records that are returned

{

    "opstatus": 0,

    "stockNews": [

        {

            "ST": "Usable",

            "RT": "2021-09-03T20:56:44-00:00",

            "PR": "Breaking International News & Views ",

            "LN": "en",

            "TY": "story",

            "LT": "2021-09-03T20:56:44-00:00",

            "HT": "GLOBAL MARKETS-Global stock benchmark at new high, dollar slips",

            "CO": ".DJI .MIAPJ0000PUS US10YT=RR .HSI CLc1 JPY= LCOc1 .AXJO JPY=D3 .CSI300 .MIWD00000PUS =USD .STOXX EUR=D3 .N225 XAU= EUR= .SPX .IXIC .KS11 .TOPX",

            "space": "preserve",

            "CT": "2021-09-03T20:56:44-00:00",

            "RE": 1,

            "AT": "RTRS",

            "PD": "NAT PSC C RBR D MTL E GRO NAW ELN G MNI CGO SOF M O PGE OIL T U RNP RAST YDB",

            "PE": "",

            "TN": 1,

            "ID": "urn:newsml:reuters.com:20210903:nL1N2Q5251",

            "TO": "NRG HK TW PREMTL WEU JP CRU ENR INFL FRX NAMER MPLT SEASIA SG ASIA NEWS1 STX PLCY DBT JOB US AUNZ COM AMERS EASIA RTRS GOL KR ASXPAC MKTREP CN CEN MCE EUROPE GVD AU METL LEN MTGFX EUROP ASEAN REP EMRG",

            "NI": "MKTS/GLOB",

            "UR": 3

        },

        {

            "ST": "Usable",

            "RT": "2021-09-02T20:51:08-00:00",

            "PR": "Breaking International News & Views ",

            "LN": "en",

            "TY": "story",

            "LT": "2021-09-02T20:51:09-00:00",

            "HT": "GLOBAL MARKETS-Stocks move higher on economic outlook, dollar cautious",

            "CO": ".DJI .GDAXI .MIAPJ0000PUS US10YT=RR .FTSE CLc1 JPY= LCOc1 .RLG .CSI300 .MIWD00000PUS .STOXX .RLV .N225 MSCI.N EUR= .SPX FB.O .IXIC .TOPX",

            "space": "preserve",

            "CT": "2021-09-02T20:51:08-00:00",

            "RE": 1,

            "AT": "RTRS",

            "PD": "NAT PSC C RBR D MTL E GRO NAW ELN G MNI CGO SOF M O PGE OIL T U RNP RAST YDB",

            "PE": "",

            "TN": 1,

            "ID": "urn:newsml:reuters.com:20210902:nL1N2Q426S",

            "TO": "INDS08 NRG PREMTL PRIS1 INFL PRIS FRX CDM GDP STX DBT US ITSE AMERS RTRS CMPNY INVI08 SWIT CEN INVS08 TECH GVD METL BISV08 CRU ENR NETSV FINS08 INT NAMER MPLT ASIA NEWS1 CMSS INDS PLCY ISER08 TECH08 ITSE08 COM EASIA GOL FINS ASXPAC MKTREP CMSS08 CN MCE LEN ISER BISV TMT REP EMRG SOCMED INVBIS",

            "NI": "MKTS/GLOB",

            "UR": 3

        }

    ],

    "totalCount": 20,

    "opstatus_getNews": 0,

    "httpStatusCode": "200"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider: Refinitiv
Enterprise API: getInstruments: News/News.svc/REST/News_1/RetrieveHeadlineML_1

Field Mapping

UI field Experience API field Refinitiv  API field
NA ST ST
News Time (Value only displayed in UI) RT RT
News Provider (Value only displayed in UI) PR PR
NA LN LN
NA TY TY
 
Description: This API retrieves the historical data for the specified duration.
Method: GET
URL: /services/data/v1/WealthOrder/operations/CurrencyDetails/getCurrencyGraph
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

ISINCode (Optional)

Specifies the ISIN code of the instrument

RICCode (Mandatory)

Specifies RIC code of the instrument

instrumentID (Mandatory)

Specifies the list of the instrument IDs.

dateOrPeriod (Mandatory)

Specifies the duration up to which the history of the price of the instrument is required

{

    "ISINCode": "ISINCode",

    "RICCode": "AMZN.O",

    "instrumentId": "100046-000",

    "dateOrPeriod": "1M"

}
Response:

Parameters

/TIMESTAMP (Mandatory)

Specifies the date and time in which the value was recorded

/CLOSE (Mandatory)

Specifies the value for the time period

 

{


    "historicalData": [

        {

            "TIMESTAMP": "2021-08-09T00:00:00+00:00",

            "CLOSE": "3341.87"

        },

        {

            "TIMESTAMP": "2021-08-10T00:00:00+00:00",

            "CLOSE": "3320.68"

        },

        {

            "TIMESTAMP": "2021-08-11T00:00:00+00:00",

            "CLOSE": "3292.11"

        },

        {

            "TIMESTAMP": "2021-08-12T00:00:00+00:00",

            "CLOSE": "3303.5"

        },

        {

            "TIMESTAMP": "2021-08-13T00:00:00+00:00",

            "CLOSE": "3293.97"

        },

        {

            "TIMESTAMP": "2021-08-16T00:00:00+00:00",

            "CLOSE": "3298.99"

        },

        {

            "TIMESTAMP": "2021-08-17T00:00:00+00:00",

            "CLOSE": "3241.96"

        },

        {

            "TIMESTAMP": "2021-08-18T00:00:00+00:00",

            "CLOSE": "3201.22"

        },

        {

            "TIMESTAMP": "2021-08-19T00:00:00+00:00",

            "CLOSE": "3187.75"

        },

        {

            "TIMESTAMP": "2021-08-20T00:00:00+00:00",

            "CLOSE": "3199.95"

        },

        {

            "TIMESTAMP": "2021-08-23T00:00:00+00:00",

            "CLOSE": "3265.87"

        },

        {

            "TIMESTAMP": "2021-08-24T00:00:00+00:00",

            "CLOSE": "3305.78"

        },

        {

            "TIMESTAMP": "2021-08-25T00:00:00+00:00",

            "CLOSE": "3299.18"

        },

        {

            "TIMESTAMP": "2021-08-26T00:00:00+00:00",

            "CLOSE": 3316

        },

        {

            "TIMESTAMP": "2021-08-27T00:00:00+00:00",

            "CLOSE": "3349.63"

        },

        {

            "TIMESTAMP": "2021-08-30T00:00:00+00:00",

            "CLOSE": "3421.57"

        },

        {

            "TIMESTAMP": "2021-08-31T00:00:00+00:00",

            "CLOSE": "3470.79"

        },

        {

            "TIMESTAMP": "2021-09-01T00:00:00+00:00",

            "CLOSE": 3479

        },

        {

            "TIMESTAMP": "2021-09-02T00:00:00+00:00",

            "CLOSE": "3463.12"

        },

        {

            "TIMESTAMP": "2021-09-03T00:00:00+00:00",

            "CLOSE": "3478.05"

        }

    ],

    "opstatus_getPricingChartDaily": 0,

    "opstatus": 0,

    "opstatus_getMarketValues": 0,

    "opstatus_getHistoricalData": 0,

    "httpStatusCode": 200,

    "status": "success"

}

Parameters

/TIMESTAMP (Mandatory)

Specifies the date and time in which the value was recorded

/CLOSE (Mandatory)

Specifies the value for the time period

 

{


    "historicalData": [

        {

            "TIMESTAMP": "2021-08-09T00:00:00+00:00",

            "CLOSE": "3341.87"

        },

        {

            "TIMESTAMP": "2021-08-10T00:00:00+00:00",

            "CLOSE": "3320.68"

        },

        {

            "TIMESTAMP": "2021-08-11T00:00:00+00:00",

            "CLOSE": "3292.11"

        },

        {

            "TIMESTAMP": "2021-08-12T00:00:00+00:00",

            "CLOSE": "3303.5"

        },

        {

            "TIMESTAMP": "2021-08-13T00:00:00+00:00",

            "CLOSE": "3293.97"

        },

        {

            "TIMESTAMP": "2021-08-16T00:00:00+00:00",

            "CLOSE": "3298.99"

        },

        {

            "TIMESTAMP": "2021-08-17T00:00:00+00:00",

            "CLOSE": "3241.96"

        },

        {

            "TIMESTAMP": "2021-08-18T00:00:00+00:00",

            "CLOSE": "3201.22"

        },

        {

            "TIMESTAMP": "2021-08-19T00:00:00+00:00",

            "CLOSE": "3187.75"

        },

        {

            "TIMESTAMP": "2021-08-20T00:00:00+00:00",

            "CLOSE": "3199.95"

        },

        {

            "TIMESTAMP": "2021-08-23T00:00:00+00:00",

            "CLOSE": "3265.87"

        },

        {

            "TIMESTAMP": "2021-08-24T00:00:00+00:00",

            "CLOSE": "3305.78"

        },

        {

            "TIMESTAMP": "2021-08-25T00:00:00+00:00",

            "CLOSE": "3299.18"

        },

        {

            "TIMESTAMP": "2021-08-26T00:00:00+00:00",

            "CLOSE": 3316

        },

        {

            "TIMESTAMP": "2021-08-27T00:00:00+00:00",

            "CLOSE": "3349.63"

        },

        {

            "TIMESTAMP": "2021-08-30T00:00:00+00:00",

            "CLOSE": "3421.57"

        },

        {

            "TIMESTAMP": "2021-08-31T00:00:00+00:00",

            "CLOSE": "3470.79"

        },

        {

            "TIMESTAMP": "2021-09-01T00:00:00+00:00",

            "CLOSE": 3479

        },

        {

            "TIMESTAMP": "2021-09-02T00:00:00+00:00",

            "CLOSE": "3463.12"

        },

        {

            "TIMESTAMP": "2021-09-03T00:00:00+00:00",

            "CLOSE": "3478.05"

        }

    ],

    "opstatus_getPricingChartDaily": 0,

    "opstatus": 0,

    "opstatus_getMarketValues": 0,

    "opstatus_getHistoricalData": 0,

    "httpStatusCode": 200,

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider:
  • ReutersServices
  • Refinitiv
  • Wealth Front Office (FO)
Enterprise API:
Refinitiv & Reuters Services:
  • getMarketValues: (ReutersServices) getFetchQuotes/$currencyPairs
  • getPricingChartDaily: TimeSeries/TimeSeries.svc/REST/TimeSeries_1/GetIntradayTimeSeries_5
  • getHistoricalData:TimeSeries/TimeSeries.svc/REST/TimeSeries_1/GetInterdayTimeSeries_5
 Wealth Front Office (FO):
  • getHistoricalData: v1.0.0/reference/instruments/$instrumentCode/displayChrono?calcFromD=$dateFrom&CalcTilld=$dateTo
     

Field Mapping

UI Field Experience API Field Wealth FO API Field
  TimeStamp DATE_D
  Close PRICE
 
Description: This API retrieves the pricing data for the requested instrument.
Method: GET
URL: services/data/v1/WealthOrder/operations/InstrumentDetails/getPricingData
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

RICCode (Mandatory)

Specifies the RIC code of the instrument 

{
 
 	"RICCode": "AMZN.O"
 	
 }
Response:

Refinitiv:

Parameters

/openRate (Mandatory)

Specifies the opening price of an instrument for the day

/volume (Mandatory)

Specifies the number of shares of an instrument traded during a given period of time

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/high52W (Mandatory)

Specifies the highest price of the instrument in the last 52-week time period

/low52W (Mandatory)

Specifies the lowest price of the instrument in the last 52-week time period

/latestRate (Mandatory)

Specifies the latest market price of an instrument

/bidRate (Mandatory)

Specifies the highest or the best price a buyer is willing to pay for an instrument

/bidVolume (Mandatory)

Specifies the quantity bid at the latest bid price

/askRate (Mandatory)

Specifies the lowest price for which someone is willing to sell a share

/askVolume (Mandatory)

Specifies the quantity offered at the latest ask price

 

{

    "opstatus_getInstruments": 0,

    "opstatus": 0,

    "pricingDetails": {

        "openRate": "3452.0",

        "volume": 2578324,

        "referenceCurrency": "USD",

        "closeRate": "3478.05",

        "high52W": "3773.0782",

        "low52W": "2871.0",

        "latestRate": "3478.05",

        "bidRate": "3471.2",

        "bidVolume": 1,

        "askVolume": 5,

        "askRate": "3474.4"

    },

    "httpStatusCode": "200"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider: Refinitiv
Enterprise API: getInstruments: Quotes/Quotes.svc/REST/Quotes_1/RetrieveItem_3

 

Fields: "CF_BID:BIDSIZE:CF_ASK:ASKSIZE:CF_VOLUME:CF_OPEN:CF_CLOSE:52WK_HIGH:52WK_LOW:CF_LAST:CF_CURRENCY"  

Field Mapping

UI field Experience API field Refinitiv  API field
Currency Symbol (Value only displayed in UI) ReferenceCurrency CF_CURRENCY
Bid BidRate CF_BID
Bid Vol BidVolume BIDSIZE
Ask AskRate CF_ASK
Ask Vol AskVolume ASKSIZE
Open OpenRate CF_OPEN
Close CloseRate CF_CLOSE
Volume Volume CF_VOLUME
52W High High52W 52WK_HIGH
52 Low Low52W 52WK_LOW
Latest LatestRate CF_LAST
 
Description: This API retrieves the list of instruments based on the search value.
Method: GET
URL: /services/data/v1/WealthOrder/operations/InstrumentDetails/getInstrumentTransactions
Security Level: NA
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Header Request:

Parameters

/portfolioID (Mandatory)

Specifies the ID field of the customer's portfolio.

/instrumentID (Mandatory)

Specifies the list of the instrument ID's.

/sortBy (Mandatory)

Specifies the field on which the sort needs to be prformed.

/pageSize (Optional)

Specifies the number of records that are to be returned by the service.

/pageOffset (Optional)

Specifies the index of the startng record.

/startDate (Mandatory)

Specifies the date from when the records are to be retrieved for the customer.

/endDate (Mandatory)

Specifies the date until when the records are to be retrieved for the customer

/sortOrder (Optional)

Specifies the order used for sorting such as ascending or descending

 

{


    "portfolioId": "100273-1",

    "instrumentId": "600600-000",

    "sortBy": "tradeDate",

    "pageSize": 10,

    "pageOffset": 0,

    "startDate": "2021-03-07",

    "endDate": "2021-09-07",

    "sortOrder": "desc"

}
Response:

Parameters

/orderType (Mandatory)

Specifies the order type such as Market, Limit, Stop Loss, and Stop Limit.

/fees (Mandatory)

Specifies the fees for the created order.

/referenceCurrency (Mandatory)

Specifies the customer’s currency.

/limitPrice (Mandatory)

Specifies the price at which the stocks are to be sold or bought.

/netAmount (Mandatory)

Specifies the total estimated amount

/instrumentID (Mandatory)

Specifies the ID of the transaction instrument

/description (Mandatory)

Specifies the name of the instrument

/instrumentAmount (Mandatory)

Specifies the transaction amount

/tradeDate (Mandatory)

Specifies the trade date of the transaction

/valueDate (Mandatory)

Specifies the value date of the transaction

/ISIN (Mandatory)

Specifies the ISIN code of the instrument

/tradeCurrency (Mandatory)

Specifies the currency of the transaction

/transactionID (Mandatory)

Specifies the unique ID of the transaction

/total (Mandatory)

Specifies the total value of the instrument transactions

/exchangeRate (Mandatory)

Specifies the exchange rate if it’s a cross-currency.

/instrumentCurrency (Mandatory)

Specifies the instrument currency

/customerID (Mandatory)

Specifies the customer ID.

/holdingsType (Mandatory)

Specifies the stock exchange

 


    "portfolioTransactions": [

        {

            "orderType": "BUY",

            "fees": "2452.15",

            "quantity": "1,000",

            "referenceCurrency": "GBP",

            "limitPrice": "1,200",

            "netAmount": "88994760",

            "instrumentId": "600600-000",

            "description": "Affle India",

            "instrumentAmount": "858614.77",

            "tradeDate": "2021-04-12",

            "valueDate": "2021-04-12",

            "ISIN": "INE00WC01019",

            "tradeCurrency": "USD",

            "transactionId": "SCTRSC21102VJG07",

            "total": "861066.92",

            "exchangeRate": "103.649230480",

            "instrumentCurrency": "INR",

            "customerId": "100273",

            "holdingsType": "NSE"

        },

        {

            "orderType": "SEL",

            "fees": "-1649.88",

            "quantity": "500",

            "referenceCurrency": "GBP",

            "limitPrice": "1,250",

            "netAmount": "4.63514375E7",

            "instrumentId": "600600-000",

            "description": "Affle India",

            "instrumentAmount": "447195.19",

            "tradeDate": "2021-04-12",

            "valueDate": "2021-04-12",

            "ISIN": "INE00WC01019",

            "tradeCurrency": "USD",

            "transactionId": "SCTRSC21102F09BJ",

            "total": "445545.31",

            "exchangeRate": "103.649230480",

            "instrumentCurrency": "INR",

            "customerId": "100273",

            "holdingsType": "NSE"

        }

    ],

    "endDate": "2021-09-07",

    "pageSize": 10,

    "totalCount": 2,

    "searchByInstrumentName": "",

    "portfolioID": "100273-1",

    "opstatus_viewInstrumentTransactions": 0,

    "sortOrder": "desc",

    "pageOffset": 0,

    "opstatus": 0,

    "sortBy": "tradeDate",

    "startDate": "2021-03-07",

    "httpStatusCode": 200,

    "status": "success"

}

Parameters

/orderType (Mandatory)

Specifies the order type such as Market, Limit, Stop Loss, and Stop Limit.

/fees (Mandatory)

Specifies the fees for the created order.

/referenceCurrency (Mandatory)

Specifies the customer’s currency.

/limitPrice (Mandatory)

Specifies the price at which the stocks are to be sold or bought.

/netAmount (Mandatory)

Specifies the total estimated amount

/instrumentID (Mandatory)

Specifies the ID of the transaction instrument

/description (Mandatory)

Specifies the name of the instrument

/instrumentAmount (Mandatory)

Specifies the transaction amount

/tradeDate (Mandatory)

Specifies the trade date of the transaction

/valueDate (Mandatory)

Specifies the value date of the transaction

/ISIN (Mandatory)

Specifies the ISIN code of the instrument

/tradeCurrency (Mandatory)

Specifies the currency of the transaction

/transactionID (Mandatory)

Specifies the unique ID of the transaction

/total (Mandatory)

Specifies the total value of the instrument transactions

/exchangeRate (Mandatory)

Specifies the exchange rate if it’s a cross-currency.

/instrumentCurrency (Mandatory)

Specifies the instrument currency

/customerID (Mandatory)

Specifies the customer ID.

/holdingsType (Mandatory)

Specifies the stock exchange

 


    "portfolioTransactions": [

        {

            "orderType": "BUY",

            "fees": "2452.15",

            "quantity": "1,000",

            "referenceCurrency": "GBP",

            "limitPrice": "1,200",

            "netAmount": "88994760",

            "instrumentId": "600600-000",

            "description": "Affle India",

            "instrumentAmount": "858614.77",

            "tradeDate": "2021-04-12",

            "valueDate": "2021-04-12",

            "ISIN": "INE00WC01019",

            "tradeCurrency": "USD",

            "transactionId": "SCTRSC21102VJG07",

            "total": "861066.92",

            "exchangeRate": "103.649230480",

            "instrumentCurrency": "INR",

            "customerId": "100273",

            "holdingsType": "NSE"

        },

        {

            "orderType": "SEL",

            "fees": "-1649.88",

            "quantity": "500",

            "referenceCurrency": "GBP",

            "limitPrice": "1,250",

            "netAmount": "4.63514375E7",

            "instrumentId": "600600-000",

            "description": "Affle India",

            "instrumentAmount": "447195.19",

            "tradeDate": "2021-04-12",

            "valueDate": "2021-04-12",

            "ISIN": "INE00WC01019",

            "tradeCurrency": "USD",

            "transactionId": "SCTRSC21102F09BJ",

            "total": "445545.31",

            "exchangeRate": "103.649230480",

            "instrumentCurrency": "INR",

            "customerId": "100273",

            "holdingsType": "NSE"

        }

    ],

    "endDate": "2021-09-07",

    "pageSize": 10,

    "totalCount": 2,

    "searchByInstrumentName": "",

    "portfolioID": "100273-1",

    "opstatus_viewInstrumentTransactions": 0,

    "sortOrder": "desc",

    "pageOffset": 0,

    "opstatus": 0,

    "sortBy": "tradeDate",

    "startDate": "2021-03-07",

    "httpStatusCode": 200,

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider:
  • Transact
  • Wealth Front Office (FO)
Enterprise API:
Transact:viewInstrumentTransactions: v2.0.0/holdings/portfolios/$portfolioId/securityTransactions?instrumentId=$instrumentId Wealth Front Office (FO): viewInstrumentTransactions: v1.0.0/holdings/portfolios/$portfolioId/$instrumentId/recentOperations?calcFromD=$startDate&calcTillD=$endDate&orderBy=$orderBy 
     

Field Mapping

UI Field Experience API field Wealth FO  API field
   HoldingsType ExchangeMarketName
   TransactionID OPERATION_CODE
  Description INSTR_NAME
  ISIN ISIN_Identifier
  InstrumentID INSTR_CODE
   Quantity QUANTITY
   TradeDate OPERATION_DATE
  ValueDate VALUE_DATE
  OrderType OPERATION_NATURE
  LimitPrice PRICE
   NetAmount GROSS_AMOUNT_OPER_CURR
   ExchangeRate EXCH_RATE
  InstrumentAmount Gross_amount_instr_ccy
  Fees bp_1_pos_amount_m+bp_2_pos_amount_m+bp_3_pos_amount_m+bp_4_pos_amount_m+bp_5_pos_amount_m+bp_6_pos_amount_m+bp_7_pos_amount_m+bp_8_pos_amount_m+bp_9_pos_amount_m
  Total NET_AMOUNT_REF_CURR
   TradeCurrency POS_CCY
  InstrumentCurrency INSTR_CCY
  CustomerID Client_ID
  ReferenceCurrency REF_CCY
  Total NET_AMOUNT_REF_CURR
 
Description: This API places a new order of the selected type such as Market, Limit, Stop Loss, and Stop Limit.
Method: POST
URL: /services/data/v1/WealthOrder/operations/Order/createSecurityOrder
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

portfolioID (Mandatory)

Specifies the ID field of the customer’s portfolio.

instrumentId (Mandatory)

Specifies the ID of the transaction instrument

customerId (Mandatory)

Specifies the customer ID

stockExchange (Mandatory)

Specifies the stock exchange

tradeCurrency (Mandatory)

Specifies the currency of the transaction

description (Mandatory)

Specifies the name of the instrument

limitPrice (Mandatory)

Specifies the price at which the stocks are to be sold or bought

marketPrice (Not Mandatory)

Specifies the latest price of the instrument.

netAmount (Not Mandatory)

Specifies the total estimated amount

order (Mandatory)

Specifies the transaction type such as Buy or FPR

orderType (Mandatory)

Specifies the order type such as Market, Limit, Stop Loss, and Stop Limit

quantity (Mandatory)

Specifies the quantity of stocks to be bought

stopLoss (Not Mandatory)

Specifies the price of the Stop Loss order

stopPrice (Not Mandatory)

Specifies the price of the Stop Limit order

validity (Mandatory)

Specifies the limit type

price (Mandatory)

Specifies the price for the transaction

dealStatus (Mandatory)

This parameter must be set to TRANSMITTED for a new order.

validate_only (Mandatory)

If this parameter is set to true, it validates the request and retrieves the estimated fees and taxes. If set to blank, it places the order.

funResultCode (Mandatory)

Specifies the cases code in Wealth FO

Market:

{

    "portfolioId": "100273-1",

    "instrumentId": "100046-000",

    "customerId": "100273",

    "stockExchange": "NYSE",

    "tradeCurrency": "GBP",

    "description": "Amazon.com",

    "limitPrice": "",

    "marketPrice": "3478.05",

    "netAmount": "347805.00",

    "order": "BUY",

    "orderType": "MARKET",

    "quantity": "100",

    "stopLoss": 0,

    "stopPrice": "",

    "validity": "GTD",

    "price": "",

    "dealStatus": "TRANSMITTED",

    "validate_only": true,

    "funcResultCode": ""

}

Limit:

{

    "portfolioId": "111653-1",

    "instrumentId": "000400-003",

    "customerId": "111653",

    "stockExchange": "LSE",

    "tradeCurrency": "GBP",

    "description": "ADMIRALGP",

    "limitPrice": "1000.00",

    "marketPrice": "8.38",

    "netAmount": "10000.00",

    "order": "BUY",

    "orderType": "LIMIT",

    "quantity": "10",

    "stopLoss": 0,

    "stopPrice": "",

    "validity": "GTD",

    "price": "",

    "dealStatus": "TRANSMITTED",

    "validate_only": true,

    "funcResultCode": ""

                }

 

Stop Loss:

{

        "portfolioId": "111653-1",

    "instrumentId": "000400-003",

    "customerId": "111653",

    "stockExchange": "LSE",

    "tradeCurrency": "GBP",

    "description": "ADMIRALGP",

    "limitPrice": "",

    "marketPrice": "8.38",

    "netAmount": "1000.00",

    "order": "BUY",

    "orderType": "STOP LOSS",

    "quantity": "10",

    "stopLoss": 0,

    "stopPrice": "",

    "validity": "GTD",

    "price": "100.00",

    "dealStatus": "TRANSMITTED",

    "validate_only": true,

    "funcResultCode": ""

}

 

Stop Limit:

{

     "portfolioId": "111653-1",

    "instrumentId": "000400-003",

    "customerId": "111653",

    "stockExchange": "LSE",

    "tradeCurrency": "GBP",

    "description": "ADMIRALGP",

    "limitPrice": "1000.00",

    "marketPrice": "8.38",

    "netAmount": "1000.00",

    "order": "BUY",

    "orderType": "STOP LIMIT",

    "quantity": "10",

    "stopLoss": 0,

    "stopPrice": "100.00",

    "validity": "GTD",

    "price": "100.00",

    "dealStatus": "TRANSMITTED",

    "validate_only": true,

    "funcResultCode": ""

}
Response:

Parameters

id (Mandatory)

Specfiies the order reference ID

message (Mandatory)

Specifies the success message after the order is placed

fees (Mandatory)

Specifies the fees for the created order 

{

    "fees": "3046.27",

    "opstatus_createMarketOrder": 0,

    "opstatus_createOrderStopLimit": 0,

    "messageDetails": "[{\"id\":\"SC-NEGATIVE.BUY.POWER\",\"message\":\"Message:Portfolio & has no buying power{100273-1\"},{\"id\":\"SC.ORD.DATE.GT.TODAY\",\"message\":\"Message:ORDER DATE GREATER THAN TODAY\"}]",

    "opstatus": 0,

    "opstatus_createOrderStopLoss": 0,

    "id": "OPODSC2110551166",

    "status": "success",    "httpStatusCode": "200"

             }

Confirm:

{

    "fees": "292.5",

    "opstatus_createMarketOrder": 0,

    "opstatus_createOrderStopLimit": 0,

    "opstatus": 0,

    "opstatus_createOrderStopLoss": 0,

    "id": "OPODSC2010804973",

    "status": "success",

    "httpStatusCode": "200"

}

Parameters

id (Mandatory)

Specfiies the order reference ID

message (Mandatory)

Specifies the success message after the order is placed

fees (Mandatory)

Specifies the fees for the created order

funResultCode (Mandatory)

Specifies the cases code in Wealth FO

 

{


 

    "fees": "0.0",

    "funcResultCode": "10027100001925",

    "messageDetails": "[{\"id\":\"20210908-000028\",\"message\":\"Warning: there are insufficient funds of  -8,165,172.92 EUR in the account for this transaction\"},
{\"id\":\"20210908-000029\",\"message\":\"The market has closed\"}]",

    "opstatus": 0,

    "opstatus_createOrders": 0,

    "opstatus_confirmOrders": 0,

    "httpStatusCode": "200",

    "status": "success"

             }

Confirm:

{

    "fees": 0,

    "opstatus": 0,

    "opstatus_createOrders": 0,

    "id": "D1002711492",

    "opstatus_confirmOrders": 0,

    "httpStatusCode": 200,

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Transact
  • Wealth Front Office (FO)
Enterprise API:
Transact:
  • Market & Limit: v1.0.0/order/securityOrders?validate_only=$validate_only
  • Stop Loss: v1.0.0/order/securityOrders/stopPriceOrders?validate_only=$validate_only
  • Stop Limit: v1.0.0/order/securityOrders/stopPriceLimitOrders?validate_only=$validate_only
 Wealth Front Office (FO):
  • Validation: v1.0.0/order/$portfolioId/createOrdersNoPub
  • Confirm: v1.0.0/order/orderSessions/$funcResultCode/confirmOrders

Field Mapping

UI Field Experience API field Wealth FO  API field TransactAPI Field
  ID ORDER_CODE ID
  FuncResultCode FunctionResultCode  
  Fees bp_1_amount_m+ bp_2_amount_m+ bp_3_amount_m+ bp_4_amount_m+ bp_5_amount_m+ bp_6_amount_m+ bp_7_amount_m+ bp_8_amount_m+ bp_9_amount_m (commission)+ (EBVFee)+ Sum of (customerChargeTaxAmount)
  MessageDetails Cases Overrides
  ID CASE_CODE Overrides
  Message DESCRIPTION Overrides
  ErrorDetails Messages OverrideDetails
  ID Code ID
  Message Message Description
 
Description: This API modifies the existing order.
Method: PUT
URL: /services/data/v1/WealthOrder/operations/Order/modifySecurityOrder
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

portfolioID (Mandatory)

Specifies the ID field of the customer’s portfolio.

quantity (Mandatory)

Specifies the number of stocks

orderType (Mandatory)

Specifies the order type such as Market and Limit.

limitPrice (Mandatory)

Specifies the price at which the stocks are to be sold or bought

price (Mandatory)

Specifies the price for the transaction

orderId (Mandatory)

Specifies the ID of the created order

validate_only (Mandatory)

If set to true, this parameter validates the request and retrieves the estimated fees and taxes. If set to blank, it places the order.

validity (Mandatory)

Specifies the limit type.

{

    "portfolioId": "100273-1",

    "quantity": "100",

    "orderType": "MARKET",

    "limitPrice": "",

    "price": "",

    "orderId": "OPODSC2110505568",

    "validate_only": true,

    "validity": "GTD"

}
Response:

Parameters

/id (Mandatory)

Specifies the order reference ID

/message (Mandatory)

/fees (Mandatory)

Specifies the fees for the created order

{

    "fees": "3046.27",

    "messageDetails": "[{\"id\":\"SC.ORD.DATE.GT.TODAY\",\"message\":\"Message:ORDER DATE GREATER THAN TODAY\"}]",

    "opstatus": 0,

    "opstatus_modifyOrder": 0,

    "id": "OPODSC2110505568",

    "status": "success",

    "httpStatusCode": "200"

}

Parameters

/id (Mandatory)

Specifies the order reference ID

/message (Mandatory)

/fees (Mandatory)

Specifies the fees for the created order

 


    "fees": "3046.27",

    "messageDetails": "[{\"id\":\"SC.ORD.DATE.GT.TODAY\",\"message\":\"Message:ORDER DATE GREATER THAN TODAY\"}]",

    "opstatus": 0,

    "opstatus_modifyOrder": 0,

    "id": "OPODSC2110505568",

    "status": "success",

    "httpStatusCode": "200"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Transact
  • Wealth Front Office (FO)
Enterprise API:
Transact: v1.0.0/order/securityOrders/$orderId?validate_only=$validate_only Wealth Front Office (FO): v1.0.0/order/updateOrders/$orderId?validate_only=$validate_only

Field Mapping

UI Field Experience API Field Wealth FO API Field
  Fees bp1AmountM+ bp2AmountM+ bp3AmountM+ bp4AmountM+ bp5AmountM+ bp6AmountM+ bp7AmountM+ bp8AmountM+ bp9AmountM
  ID Code
  MessageDetails  
  ID  
  Message  
  Error Details Messages
  ID Code
  Message Message
 
Description: This API cancels the order that is placed for either buying or selling.
Method: PUT
URL: /services/data/v1/WealthOrder/operations/Order/cancelSecurityOrder
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

portfolioId (Mandatory)

Specifies the ID field of the customer’s portfolio.

orderId (Mandatory)

Specifies the order reference ID.

assetType (Optional)

The type of the asset class that the instrument belong to.

{

    "portfolioId": "100271-1",

    "orderId": "D1002711004",

    "assetType": "Stock"

}
Response:

Parameters

orderId (Mandatory)

Specifies the order reference ID .

message (Mandatory)

Specifies the success message after the order is placed

Id (Mandatory)

Specifies the unique ID for the favorite Instruments list of the customer.

{

    "orderId": "OPODSC2110548767",

    "messageDetails": "[{\"id\":\"SC.ORD.DATE.GT.TODAY\",\"message\":\"Message:ORDER DATE GREATER THAN TODAY\"}]",

    "opstatus_cancelOrder": 0,

    "opstatus": 0,

    "status": "success",

    "httpStatusCode": "200"

}

Parameters

orderId (Mandatory)

Specifies the order reference ID .

message (Mandatory)

Specifies the success message after the order is placed

Id (Mandatory)

Specifies the unique ID for the favorite Instruments list of the customer.

 

{


    "orderId": "OPODSC2110548767",

    "messageDetails": "[{\"id\":\"SC.ORD.DATE.GT.TODAY\",\"message\":\"Message:ORDER DATE GREATER THAN TODAY\"}]",

    "opstatus_cancelOrder": 0,

    "opstatus": 0,

    "status": "success",

    "httpStatusCode": "200"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Transact
  • Wealth Front Office (FO)
Enterprise API:
Transact: Cancel Order: v1.0.0/order/securityOrders/$orderId Wealth Front Office (FO):
  • CancelDMAOrders: v1.0.0/order/orders/cancelDMAOrders
  • CancelNDMAOrders:v1.0.0/order/orders/cancelNDMAOrders

Field Mapping

UI field Experience API Field Wealth FO API Field Transact API Field
Reference ID Order ID OrderID from request ID
NA MessageDetails   Overrides
NA ID   Overrides
NA Message   Overrides
NA Error Details   Overrides, Error Details
NA ID   ID, Code
NA Message   Description, Message
 
Description: This API returns the list of currencies.
Method: GET
URL: /services/data/v1/WealthOrder/operations/Order/getCurrencyList
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

None.
Response:

Parameters

/AddCurrency (Mandatory)

Specifies the JSON array containing the list of currency details

/CurrencyCode (Mandatory)

Specifies the currency code

/CurrencyValue (Mandatory)

Specifies the name of the currency

{

    "opstatus_getNoDataReturnedMock": 0,

    "opstatus": 0,

    "httpStatusCode": "200",

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider: NA
Enterprise API: NA

Field Mapping

No field mapping for this API.

 
Description: This API retrieves the market rates for the currency pairs.
Method: GET
URL: /services/data/v1/WealthOrder/operations/Order/getMarketRates
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

currencyPairs (Mandatory)

Specifies the currency pairs whose market rate is required 

{
 
 	" currencyPairs ": "EURUSD"
 	
 }
Response:

Parameters

/marketRate (Mandatory)

Specifies the exchange rate between the two currencies 

{

    "opstatus_getNoDataReturnedMock": 0,

    "opstatus": 0,

    "httpStatusCode": "200",

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider: NA
Enterprise API: NA

Field Mapping

No field mapping for this API.

 
Description: This API retrieves the favorite instruments of the user.
Method: GET
URL: /services/data/v1/WealthOrder/operations/Watchlist/getWatchlistDB
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

ISINCode (Optional)

Specifies the ISIN code of the instrument

RICCode (Optional)

Specifies the RIC code of the instrument

instrumentID (Optional)

Specifies the unique ID of the instrument

 

{

    "ISINCode": "ISINCode",

    "RICCode": "AMZN.O",

    "instrumentId": "100046-000"

}
Response:

Parameters

/customerId (Mandatory)

Specifies the ID of the customer

/id (Mandatory)

Specifies the unique ID for the favorite Instruments list of the customer.

/favInstrumentCodes (Mandatory)

Specifies the RIC codes of instruments listed as favorites

/userId (Mandatory)

Specifies the user ID of the customer

/favInstrumentsId (Mandatory)

Specifies the instrument code which is watchlisted.

{

    "customerId": "7782055792",

    "id": "24",

    "favInstrumentCodes": "AMZN.O",

    "userId": "7782055792",

    "favInstrumentIds": "100046-000",

    "opstatus": 0,

    "httpStatusCode": "0"

}
Error Code(s):
  • Error Code: 12001
  • Error Message: Logged in user is not authorized to perform this action.
Enterprise Provider: NA
Enterprise API: NA

Field Mapping

No field mapping for this API.

 
Description: This API updates the favorite instruments of the user.
Method: GET
URL: /services/data/v1/WealthOrder/operations/Watchlist/updateWatchlistDB
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

ISINCode (Optional)

Specifies the ISIN code of the instrument

RICCode (Optional)

Specifies the RIC code of the instrument

instrumentID (Optional)

Specifies the unique ID of the instrument

operation (Mandatory)

Specifies whether to add or delete the instruments from the favorites list

{

    "ISINCode": "ISINCode",

    "RICCode": "AMZN.OQ",

    "instrumentId": "100049-000",

    "operation": "Add"

}

{

    "ISINCode": "ISINCode",

    "RICCode": "AMZN.OQ",

    "instrumentId": "100049-000",

    "operation": "Remove"

}
Response:

Parameters

/id (Mandatory)

Specifies the unique ID for the favorite Instruments’ list of the customer

/favInstrumentCodes (Mandatory)

Specifies the RIC code of the instruments listed as favorites

/favInstrumentId (Mandatory)

Specifies the instrument code which is watchlisted.

 

{

    "id": "23",

    "favInstrumentCodes": "AMZN.O:AMZN.OQ",

    "favInstrumentIds": "100046-000:100049-000",

    "opstatus": 0,

    "httpStatusCode": "0"

}

{

    "id": "24",

    "favInstrumentCodes": "AMZN.O",

    "favInstrumentIds": "100046-000",

    "opstatus": 0,

    "httpStatusCode": "0"

}
Error Code(s):
  • Error Code: 12001
  • Error Message: Logged in user is not authorized to perform this action.
Enterprise Provider: NA
Enterprise API: NA

Field Mapping

No field mapping for this API.

 
Description: This API creates a forex order.
Method: GET
URL: /services/data/v1/WealthOrder/operations/CurrencyDetails/createCurrencyOrder
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

buyCurrency (Mandatory)

Specifies the To Currency

sellCurrency (Mandatory)

Specifies the From Currency

buyAmount (Mandatory)

Specifies the amount of the currency bought

sellAmount (Mandatory)

Specifies the amount of the currency sold

{

    "buyCurrency": "USD",

    "sellCurrency": "GBP",

    "buyAmount": "1000",

    "sellAmount": "2000"

}
Response:

Parameters

fees (Mandatory)

Specifies the fees for the created order

uniqueIdentifier (Mandatory)

Specifies the unique order reference ID

{

    "opstatus_getNoDataReturnedMock": 0,

    "opstatus": 0,

    "httpStatusCode": "200",

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider: NA
Enterprise API: NA

Field Mapping

No field mapping for this API.

 
Description: This API retrieves the stock news for the specified instrument RIC code.
Method: GET
URL: /services/data/v1/WealthOrder/operations/InstrumentDetails/getNewsDetails
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

RICCode (Mandatory)

Specifies the RIC code of the instrument

pageSize (Mandatory)

Specifies the number of records that are to be returned

pageOffset (Mandatory)

Specifies the index of the starting record

{

    "RICCode": "AMZN.O",

    "pageSize": 4,

    "pageOffset": 0

}
Response:

Parameters

/TE (Mandatory)

Specifies the story

/CT (Mandatory)

Specifies the news item creation time

/RT (Mandatory)

Specifies the news item revision item

/PR (Mandatory)

Specifies the news item provider

/ID (Mandatory)

Specifies the global unique ID

/HT (Mandatory)

Specifies the news item headline

/totalCount

Specifies the total records that are returned

{

    "stockNewsDetails": [

        {

            "TE": " (Adds Viasat, UniCredit, Petrobras, Future Group, Toshiba,\nTreeHouse Foods; Updates Neinor Homes, Open Fiber)\n    Nov 8 (Reuters) - The following bids, mergers, acquisitions\nand disposals were reported by 2100 GMT on Monday:\n    \n    ** Viasat  <Origin Href=\"QuoteRef\">VSAT.O</Origin>  agreed to buy British rival Inmarsat on\nMonday in a $7.3 billion deal to broaden the U.S.-based\ncompany&apos;s satellite and land-based communications services.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ3IA</Origin>\n    \n    ** Italian state lender Cassa Depositi e Prestiti (CDP) and\nAustralian fund Macquarie are set to secure unconditional EU\nantitrust approval for their acquisition of broadband network\ncompany Open Fiber, sources close to the matter said.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ1NY</Origin>\n    \n    ** UniCredit  <Origin Href=\"QuoteRef\">CRDI.MI</Origin>  set strict terms in July for a\npotential merger with Monte dei Paschi  <Origin Href=\"QuoteRef\">BMPS.MI</Origin>  to reassure\ninvestors in relation to a deal that could be perceived by\nmarkets as being forced onto the bank by politics, CEO Andrea\nOrcel said.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL8N2RZ624</Origin>\n    \n    ** Brazilian President Jair Bolsonaro reiterated that he\nwould like to privatize state-run oil company Petroleo\nBrasileiro SA  <Origin Href=\"QuoteRef\">PETR4.SA</Origin> , saying his ideal plan would be to\ncarve it up rather than selling it to one buyer.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ1EP</Origin>\n    \n    ** India&apos;s financial crime fighting agency has ordered\nFuture Group to submit documents related to its 2019 deal with\nAmazon.com Inc  <Origin Href=\"QuoteRef\">AMZN.O</Origin>  as part of an investigation into\npossible breach of foreign investment laws, according to sources\nand a notice seen by Reuters.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ2QW</Origin>\n    \n    ** Toshiba Corp  <Origin Href=\"QuoteRef\">6502.T</Origin>  is considering splitting itself\ninto three companies focused separately on infrastructure,\ndevices and memory chips, a spokesperson said, a move that could\naddress the Japanese firm&apos;s persistent conglomerate discount.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ308</Origin>\n    \n    ** TreeHouse Foods Inc  <Origin Href=\"QuoteRef\">THS.N</Origin>  said it was exploring options\nincluding a sale of the company or divestment of a unit, months\nafter hedge fund Jana Partners pushed for changes saying the\npackaged food maker was undervalued.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ2S5</Origin>\n\n    ** McAfee Corp  <Origin Href=\"QuoteRef\">MCFE.O</Origin>  said a consortium led by U.S.\nprivate equity firm Advent International will buy the Cyber\nsecurity firm in a $14 billion deal.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ37J</Origin>\n    \n    ** Spanish residential real estate developer Neinor Homes\n <Origin Href=\"QuoteRef\">HOME.MC</Origin>  confirmed reports it is in negotiations to buy rival\nVia Celere in a deal that could create Spain&apos;s largest property\ndeveloper.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ0E2</Origin>\n    \n    ** Playtech  <Origin Href=\"QuoteRef\">PTEC.L</Origin>  is in talks with its second-biggest\nshareholder over a possible takeover offer, weeks after agreeing\nto a buyout from rival Aristocrat Leisure  <Origin Href=\"QuoteRef\">ALL.AX</Origin> , sending the\nBritish online gambling software firm shares up 3%.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ0AK</Origin>\n    \n    ** Shares in Coloplast  <Origin Href=\"QuoteRef\">COLOb.CO</Origin>  rose after the medical\nequipment maker said it had agreed to a 2.16 billion euros\n($2.49 billion) deal to buy Atos Medical, which specialises in\nlaryngectomy, from French private equity firm PAI Partners.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ0DE</Origin>\n            \n    ** Private equity companies Hellman &amp; Friedman (H&amp;F) and EQT\nsaid they had reached an acceptance rate of around 82% for their\njoint takeover offer of German online pet supplied retailer\nZooplus  <Origin Href=\"QuoteRef\">ZO1G.DE</Origin> .  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nASN001UR4</Origin>\n    \n    ** Alcon  <Origin Href=\"QuoteRef\">ALCC.S</Origin>  has agreed to buy Ivantis, the maker of a\ntiny stent to treat glaucoma, for an initial $475 million, the\nSwiss eye care company said.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ07Y</Origin>\n        \n    ** Sydney Airport Holdings  <Origin Href=\"QuoteRef\">SYD.AX</Origin>  said it has agreed to\naccept a A$23.6 billion ($17.5 billion) takeover bid from an\ninfrastructure investor group in one of Australia&apos;s biggest\nbuyouts.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0GM</Origin>\n    \n    ** Global miner BHP Group Ltd  <Origin Href=\"QuoteRef\">BHP.AX</Origin>  signed a deal to sell\nits stake in BHP Mitsui Coal (BMC), a metallurgical coal joint\nventure in Queensland, to Stanmore Resources Ltd  <Origin Href=\"QuoteRef\">SMR.AX</Origin>  for up\nto $1.35 billion, the companies said.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0G7</Origin>\n    \n    ** Hong Kong-listed Link Real Estate Investment Trust\n <Origin Href=\"QuoteRef\">0823.HK</Origin>  said it has agreed to buy 50% interests in three\nretail properties in Sydney from Ipoh Property Pty Ltd for\nA$538.2 million ($398.16 million).  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ009</Origin>\n    \n    ** Australian coal seam gas producer Senex Energy Ltd\n <Origin Href=\"QuoteRef\">SXY.AX</Origin>  said it would recommend an A$852 million ($630 million)\ntakeover offer from POSCO International Corp, after the South\nKorean firm raised its proposed bid for a third time.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0HL</Origin>\n    \n    ** Australian Pharmaceutical Industries  <Origin Href=\"QuoteRef\">API.AX</Origin>  said it had\nsigned an agreement with Wesfarmers Ltd  <Origin Href=\"QuoteRef\">WES.AX</Origin>  for the retail\nconglomerate to buy all of its shares in a deal valuing the\npharmacy chain at A$763.6 million ($564.9 million).  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0H5</Origin>\n        \n    ** Commonwealth Bank of Australia  <Origin Href=\"QuoteRef\">CBA.AX</Origin>  said it acquired\na minority stake in a Silicon Valley-based artificial\nintelligence (AI) firm, H2O.ai Inc, in a bid to provide smarter\nand personalised products to its customer base.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0EI</Origin>\n\n (Compiled by Rajarshi Roy, Oishee Majumdar and Sohini Podder in\nBengaluru)\n ((oishee.majumdar@thomsonreuters.com))",

            "CT": "2021-11-08T14:36:58-00:00",

            "RT": "2021-11-08T21:00:00-00:00",

            "PR": "Breaking International News & Views ",

            "ID": "urn:newsml:reuters.com:20211108:nL4N2RZ3FV",

            "HT": "Deals of the day-Mergers and acquisitions"

        }

    ],

    "opstatus_getNewsWeb": 0,

    "opstatus": 0,

    "totalCount": 20,

    "httpStatusCode": 200,

    "status": "success"

}
Error Code(s): Error Message: Unauthorized Access
Enterprise Provider: Refinitiv
Enterprise API:
  • getNewsWeb: News/News.svc/REST/News_1/RetrieveHeadlineML_1
  • getNewsStoryWeb:OnlineReports/OnlineReports.svc/REST/OnlineReports_1/GetSummaryByStories_1

Field Mapping

UI Field Experience API Field Refinitiv API Field
News Description (Value only displayed in UI) TE TE
NA CT CT
News Time (Value only displayed in UI) RT RT
News provider (Value only displayed in UI) PR PR
NA ID ID
News Heading (Value only displayed in UI) HT HT
 
Description: This API retrieves the stock news story for the instrument story ID.
Method: GET
URL: /services/data/v1/WealthOrder/operations/InstrumentDetails/getNewsStory
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

StoryId (Mandatory)

Specifies the story ID of the instrument 

{
    "StoryId":"urn:newsml:reuters.com:20211108:nL4N2RZ3FV"
}
Response:

Parameters

/TE (Mandatory)

Specifies the story

/RT (Mandatory)

Specifies the news item revision item

/PR (Mandatory)

Specifies the news item provider

/HT (Mandatory)

Specifies the news item headline

/ID (Mandatory)

Specifies the global unique ID

{

    "opstatus_getNewsStory": 0,

    "opstatus": 0,

    "stockNewsStory": {

        "TE": " (Adds Viasat, UniCredit, Petrobras, Future Group, Toshiba,\nTreeHouse Foods; Updates Neinor Homes, Open Fiber)\n    Nov 8 (Reuters) - The following bids, mergers, acquisitions\nand disposals were reported by 2100 GMT on Monday:\n    \n    ** Viasat  <Origin Href=\"QuoteRef\">VSAT.O</Origin>  agreed to buy British rival Inmarsat on\nMonday in a $7.3 billion deal to broaden the U.S.-based\ncompany&apos;s satellite and land-based communications services.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ3IA</Origin>\n    \n    ** Italian state lender Cassa Depositi e Prestiti (CDP) and\nAustralian fund Macquarie are set to secure unconditional EU\nantitrust approval for their acquisition of broadband network\ncompany Open Fiber, sources close to the matter said.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ1NY</Origin>\n    \n    ** UniCredit  <Origin Href=\"QuoteRef\">CRDI.MI</Origin>  set strict terms in July for a\npotential merger with Monte dei Paschi  <Origin Href=\"QuoteRef\">BMPS.MI</Origin>  to reassure\ninvestors in relation to a deal that could be perceived by\nmarkets as being forced onto the bank by politics, CEO Andrea\nOrcel said.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL8N2RZ624</Origin>\n    \n    ** Brazilian President Jair Bolsonaro reiterated that he\nwould like to privatize state-run oil company Petroleo\nBrasileiro SA  <Origin Href=\"QuoteRef\">PETR4.SA</Origin> , saying his ideal plan would be to\ncarve it up rather than selling it to one buyer.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ1EP</Origin>\n    \n    ** India&apos;s financial crime fighting agency has ordered\nFuture Group to submit documents related to its 2019 deal with\nAmazon.com Inc  <Origin Href=\"QuoteRef\">AMZN.O</Origin>  as part of an investigation into\npossible breach of foreign investment laws, according to sources\nand a notice seen by Reuters.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ2QW</Origin>\n    \n    ** Toshiba Corp  <Origin Href=\"QuoteRef\">6502.T</Origin>  is considering splitting itself\ninto three companies focused separately on infrastructure,\ndevices and memory chips, a spokesperson said, a move that could\naddress the Japanese firm&apos;s persistent conglomerate discount.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ308</Origin>\n    \n    ** TreeHouse Foods Inc  <Origin Href=\"QuoteRef\">THS.N</Origin>  said it was exploring options\nincluding a sale of the company or divestment of a unit, months\nafter hedge fund Jana Partners pushed for changes saying the\npackaged food maker was undervalued.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ2S5</Origin>\n\n    ** McAfee Corp  <Origin Href=\"QuoteRef\">MCFE.O</Origin>  said a consortium led by U.S.\nprivate equity firm Advent International will buy the Cyber\nsecurity firm in a $14 billion deal.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL4N2RZ37J</Origin>\n    \n    ** Spanish residential real estate developer Neinor Homes\n <Origin Href=\"QuoteRef\">HOME.MC</Origin>  confirmed reports it is in negotiations to buy rival\nVia Celere in a deal that could create Spain&apos;s largest property\ndeveloper.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ0E2</Origin>\n    \n    ** Playtech  <Origin Href=\"QuoteRef\">PTEC.L</Origin>  is in talks with its second-biggest\nshareholder over a possible takeover offer, weeks after agreeing\nto a buyout from rival Aristocrat Leisure  <Origin Href=\"QuoteRef\">ALL.AX</Origin> , sending the\nBritish online gambling software firm shares up 3%.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ0AK</Origin>\n    \n    ** Shares in Coloplast  <Origin Href=\"QuoteRef\">COLOb.CO</Origin>  rose after the medical\nequipment maker said it had agreed to a 2.16 billion euros\n($2.49 billion) deal to buy Atos Medical, which specialises in\nlaryngectomy, from French private equity firm PAI Partners.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ0DE</Origin>\n            \n    ** Private equity companies Hellman &amp; Friedman (H&amp;F) and EQT\nsaid they had reached an acceptance rate of around 82% for their\njoint takeover offer of German online pet supplied retailer\nZooplus  <Origin Href=\"QuoteRef\">ZO1G.DE</Origin> .  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nASN001UR4</Origin>\n    \n    ** Alcon  <Origin Href=\"QuoteRef\">ALCC.S</Origin>  has agreed to buy Ivantis, the maker of a\ntiny stent to treat glaucoma, for an initial $475 million, the\nSwiss eye care company said.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ07Y</Origin>\n        \n    ** Sydney Airport Holdings  <Origin Href=\"QuoteRef\">SYD.AX</Origin>  said it has agreed to\naccept a A$23.6 billion ($17.5 billion) takeover bid from an\ninfrastructure investor group in one of Australia&apos;s biggest\nbuyouts.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0GM</Origin>\n    \n    ** Global miner BHP Group Ltd  <Origin Href=\"QuoteRef\">BHP.AX</Origin>  signed a deal to sell\nits stake in BHP Mitsui Coal (BMC), a metallurgical coal joint\nventure in Queensland, to Stanmore Resources Ltd  <Origin Href=\"QuoteRef\">SMR.AX</Origin>  for up\nto $1.35 billion, the companies said.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0G7</Origin>\n    \n    ** Hong Kong-listed Link Real Estate Investment Trust\n <Origin Href=\"QuoteRef\">0823.HK</Origin>  said it has agreed to buy 50% interests in three\nretail properties in Sydney from Ipoh Property Pty Ltd for\nA$538.2 million ($398.16 million).  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RZ009</Origin>\n    \n    ** Australian coal seam gas producer Senex Energy Ltd\n <Origin Href=\"QuoteRef\">SXY.AX</Origin>  said it would recommend an A$852 million ($630 million)\ntakeover offer from POSCO International Corp, after the South\nKorean firm raised its proposed bid for a third time.\n <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0HL</Origin>\n    \n    ** Australian Pharmaceutical Industries  <Origin Href=\"QuoteRef\">API.AX</Origin>  said it had\nsigned an agreement with Wesfarmers Ltd  <Origin Href=\"QuoteRef\">WES.AX</Origin>  for the retail\nconglomerate to buy all of its shares in a deal valuing the\npharmacy chain at A$763.6 million ($564.9 million).  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0H5</Origin>\n        \n    ** Commonwealth Bank of Australia  <Origin Href=\"QuoteRef\">CBA.AX</Origin>  said it acquired\na minority stake in a Silicon Valley-based artificial\nintelligence (AI) firm, H2O.ai Inc, in a bid to provide smarter\nand personalised products to its customer base.  <Origin Href=\"StoryRef\">urn:newsml:reuters.com:*:nL1N2RY0EI</Origin>\n\n (Compiled by Rajarshi Roy, Oishee Majumdar and Sohini Podder in\nBengaluru)\n ((oishee.majumdar@thomsonreuters.com))",

        "RT": "2021-11-08T21:00:00-00:00",

        "PR": "Breaking International News & Views ",

        "ID": "urn:newsml:reuters.com:20211108:nL4N2RZ3FV",

        "HT": "Deals of the day-Mergers and acquisitions"

    },

    "httpStatusCode": "200"

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider: Refinitiv
Enterprise API: getNewsStory: OnlineReports/OnlineReports.svc/REST/OnlineReports_1/GetSummaryByStories_1

Field Mapping

UI Field Experience API Field Refinitiv API Field
News Description (Value only displayed in UI) TE TE
News time (Value only displayed in UI) RT RT
News provider (Value only displayed in UI) PR PR
NA ID ID
News Heading (Value only displayed in UI) HT HT

 

 
Description: This API retrieves the list of the instruments.
Method: POST
URL: {{URL}}/services/data/v1/WealthOrder/operations/FavouriteInstruments/getSearchFavoriteInstruments
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

isFavouriteSearch (Optional)

Specifies the whether it is normal search or watchlist search.

sortBy (Mandatory)

Specifies the field on which the sort needs to be performed.

searchByInstrumentName (Mandatory)

Specifies the value on which the search needs to be performed.

{
    "isFavouriteSearch" : "true",
    "sortBy" : "volume",
    "searchByInstrumentName" : "Ama"
}
Response:

Parameters

/searchfavoriteInstruments (Mandatory)

Specifies the JSON array that contains the searchfavouriteInstruments details.

/holdingsId (Mandatory)

Specifies The holdings ID

/secCCy (Mandatory)

Specifies Currency Type

/marketPrice (Mandatory)

Specifies the market value of the object.

/application (Mandatory)

Specifies the Application Type of the Object.

/instrumentId (Mandatory)

Specifies the instrument ID.

/percentageChange (Mandatory)

Determines the percentage change of the object.

/RICCode (Mandatory)

Determine the RICcode of the current object.

/description (Mandatory)

Indicates the description of the object.

/isSecurityAsset (Mandatory)

Displays if the value is True or not.

/ISIN (Mandatory)

Specifies the ISIN code of the object.

/holdingsType (Mandatory)

Indicates the Holding type of the user

/isFavorite (Mandatory)

Displays if the value is True or not based on user.

 
{
    "searchfavoriteInstruments": [
        {
            "holdingsId": "100021-000",
            "secCCy": "USD",
            "marketPrice": "3203.53",
            "application": "SC",
            "instrumentId": "100021-000",
            "percentageChange": "0.51",
            "RICCode": "AMZN.OQ",
            "description": "Amazon.com Inc",
            "isSecurityAsset": true,
            "ISIN": "US0231351067",
            "holdingsType": "NYSE",
            "isFavorite": true
        }
    ],
    "opstatus": 0,
    "httpStatusCode": "200",
    "status": "success"
}

Parameters

/searchfavoriteInstruments (Mandatory)

Specifies the JSON array that contains the searchfavouriteInstruments details.

/holdingsId (Mandatory)

Specifies The holdings ID

/secCCy (Mandatory)

Specifies Currency Type

/marketPrice (Mandatory)

Specifies the market value of the object.

/application (Mandatory)

Specifies the Application Type of the Object.

/instrumentId (Mandatory)

Specifies the instrument ID.

/percentageChange (Mandatory)

Determines the percentage change of the object.

/RICCode (Mandatory)

Determine the RICcode of the current object.

/description (Mandatory)

Indicates the description of the object.

/isSecurityAsset (Mandatory)

Displays if the value is True or not.

/ISIN (Mandatory)

Specifies the ISIN code of the object.

/holdingsType (Mandatory)

Indicates the Holding type of the user

/isFavorite (Mandatory)

Displays if the value is True or not based on user.

/idCode (Mandatory)

Specifies the id based on the application

{
    "searchfavoriteInstruments": [
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "DX",
            "instrumentId": "230000/USD/20180921/PUT/380.00//E",
            "idCode": "2051",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Options",
            "ISIN": "",
            "holdingsType": "700",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "DX",
            "instrumentId": "230000/USD/20180921/PUT/381.00//E",
            "idCode": "2055",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Options",
            "ISIN": "",
            "holdingsType": "700",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "DX",
            "instrumentId": "230000/USD/20181121/CALL/380.00//E",
            "idCode": "2059",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Options",
            "ISIN": "",
            "holdingsType": "700",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "100046-000",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon.com",
            "ISIN": "US0231351067",
            "holdingsType": "MKT_NYSE",
            "isFavorite": true
        }
    ],
    "opstatus": 0,
    "httpStatusCode": "200",
    "status": "success"
}

Parameters

/searchfavoriteInstruments (Mandatory)

Specifies the JSON array that contains the searchfavouriteInstruments details.

/holdingsId (Mandatory)

Specifies The holdings ID

/secCCy (Mandatory)

Specifies Currency Type

/marketPrice (Mandatory)

Specifies the market value of the object.

/application (Mandatory)

Specifies the Application Type of the Object.

/instrumentId (Mandatory)

Specifies the instrument ID.

/percentageChange (Mandatory)

Determines the percentage change of the object.

/RICCode (Mandatory)

Determine the RICcode of the current object.

/description (Mandatory)

Indicates the description of the object.

/isSecurityAsset (Mandatory)

Displays if the value is True or not.

/ISIN (Mandatory)

Specifies the ISIN code of the object.

/holdingsType (Mandatory)

Indicates the Holding type of the user

/isFavorite (Mandatory)

Displays if the value is True or not based on user.

{
    "searchfavoriteInstruments": [
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "480480-001",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Equity Fund",
            "ISIN": "",
            "holdingsType": "NYSE",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "480480-002",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Equity Fund",
            "ISIN": "",
            "holdingsType": "NYSE",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "480480-003",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Equity Fund",
            "ISIN": "",
            "holdingsType": "NYSE",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "480480-004",
            "percentageChange": "",
            "RICCode": "",
            "description": "Amazon Equity Fund",
            "ISIN": "",
            "holdingsType": "NYSE",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "100046-000",
            "percentageChange": "",
            "RICCode": "AMZN.O",
            "description": "Amazon.com",
            "ISIN": "US0231351067",
            "holdingsType": "NYSE",
            "isFavorite": true
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "SC",
            "instrumentId": "970000-251",
            "percentageChange": "",
            "RICCode": "CCL.AX",
            "description": "Coca-Cola Amatil Limited",
            "ISIN": "",
            "holdingsType": "ASX",
            "isFavorite": false
        },
        {
            "secCCy": "",
            "marketPrice": "",
            "application": "DXMaster",
            "instrumentId": "230000",
            "percentageChange": "",
            "RICCode": "",
            "description": "EUREX Amazon Options",
            "ISIN": "",
            "holdingsType": "",
            "isFavorite": false
        }
    ],
    "opstatus": 0,
    "httpStatusCode": "200",
    "status": "success"
}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider: NA
Enterprise API:
  • v1.0.0/reference/instruments?searchPattern=$instrumentName
  • v1.0.0/reference/synonyms?objectID=$ID
  • v1.0.0/reference/instruments/$instrumentID Quotes/Quotes.svc/REST/Quotes_1/RetrieveItem_3

Field Mapping

UI Field Experience API Field Refinitiv API Field
Details Application  
  instrumentId code
  RICCode  
  Description name
  ISIN extIsinSynC
  holdingsType marketThirdCode
  idCode id
  nature natureE
 
 
Description: This API retreives the instrument details of a particular instrument.
Method: POST
URL: {{URL}}/services/data/v1/WealthOrder/operations/ProductDetails/getProductDetailsFromId
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

instrumentId (Mandatory)

Specifies the instrument ID.

application (Mandatory)

Specifies the ID of customer’s portfolio.

{ 

    "ISINCode": "ISINCode", 

    "RICCode": "RICCode", 

    "instrumentId": "000402-000", 

    "application": "SC" 

}
Response:

Parameters

/status (Mandatory)

Specifies whether the service is success or not.

/assetTypes (Mandatory)

Specifies the JSON object of asset details

/productDetails (Mandatory)

Specifies the JSON object of instrument details.

{ 

    "opstatus_getInstruments": 0, 

    "instrumentAssets": { 

        "assetTypes": { 

            "interestRate": "8.75", 

            "duration": "[7y-10y] Duration", 

            "maturityDate": "2033-11-21", 

            "yield": "0.01", 

            "rating": "", 

            "nxtCoupnDate": "2004-11-20T00:00:00", 

            "modifiedDuration": "7.400519348", 

            "assetType": "Fixed Income" 

        }, 

        "isSecurityAsset": true 

    }, 

    "opstatus_getProductDetails": 0, 

    "opstatus_getDocuments": 0, 

    "opstatus_getSynonyms": 0, 

    "opstatus_getInstrumentMinimal": 0, 

    "totalCount": 0, 

    "productDetails": { 

        "stockExchange": "MKT_NYSE", 

        "marketPrice": "1.7023", 

        "referenceCurrency": "USD", 

        "quantity": "", 

        "ISINCode": "US715638AP79", 

        "netchange": "", 

        "instrumentId": "000402-000", 

        "percentageChange": "", 

        "isinExchange": "US715638AP79 | MKT_NYSE", 

        "assetType": "Fixed Income", 

        "formatted_netperChange": " ", 

        "instrumentName": "Peru, Republik Obligation 33 8.75 ", 

        "application": "SC", 

        "dateReceived": "", 

        "RICCode": "", 

        "timeReceived": "", 

        "isSecurityAsset": "true", 

        "instrumentCurrencyId": "USD" 

    }, 

    "opstatus_getNews": 0, 

    "opstatus_getInstrumentDetails": 0, 

    "documentDetails": [], 

    "Field": [], 

    "instrumentMinimal": [ 

        { 

            "stockExchange": "MKT_NYSE", 

            "marketPrice": "1.7023", 

            "instrumentName": "Peru, Republik Obligation 33 8.75 ", 

            "referenceCurrency": "USD", 

            "quantity": "", 

            "ISINCode": "US715638AP79", 

            "instrumentId": "000402-000", 

            "dateReceived": "", 

            "RICCode": "", 

            "id": "176001", 

            "instrumentCurrencyId": "USD", 

            "yeildToMaturity": "0.012818066" 

        } 

    ], 

    "opstatus": 0, 

    "id": "176001", 

    "stockNews": [], 

    "opstatus_getPricingData": 0, 

    "opstatus_getStockNews": 0, 

    "httpStatusCode": 200, 

    "status": "success" 

}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider: Wealth FO
Enterprise API: {{TAP_HOST_URL}}/v1.0.0/reference/instrumentDetails?code=000402-000

Field Mapping

UI Field Experience API Field Wealth FO API Field
Product Details productDetails  
Asset details assetTypes  
 
 
Description: This API used to generate base64 for download functionality.
Method: POST
URL: {{URL}}/services/data/v1/WealthOrder/operations/DownloadOrderPDF/generatePDF
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

navPage (Mandatory)

Specifies the functionality which needs to be downloaded.

sortBy (Mandatory)

Specifies the sort parameter.

portfolioId (Mandatory)

Specifies the ID field of the portfolio.

pageSize (Mandatory)

Specifies the page size.

pageOffset (Mandatory)

Specifies the page offset.

sortOrder (Mandatory)

Specifies the order of sorting.

isEuro (Mandatory)

Specifies whether the currency is euro or not.

downloadFormat (Mandatory)

Specifies the download format.

{ 
    "navPage": "Watchlist",
    "sortBy": "instrumentName",
    "sortOrder": "asc",
    "pageOffset": "0",
    "pageSize": "10",
    "portfolioId": "100777-1",
    "isEuro": "true",
    "downloadFormat": "csv"
}
Response:

Parameters

/base64 (Mandatory)

Specifies base64 value for download.

{ 
   "base64": "TmFtZTogLEhpbWFqYVNyaWRoYXINClBvcnRmb2xpbzogLDEwMDc3Ny0xDQoNCldhdGNobGlzdCBSZXBvcnQNCldhdGNobGlzdCBSZXBvcnQgYXMgb24gMjAyMy8xMi8xOA0KDQoNCkluc3RydW1lbnROYW1lLElTSU4sRXhjaGFuZ2UsQ3VycmVuY3ksTGF0ZXN0LENoYW5nZSxEYXRlVGltZSxCaWQsQXNrLFZvbHVtZSwNCiJHb29nbGUgTExDIiwiVVMwMjA3OUsxMDc5IiwiTllTRSIsIlVTRCIsIiQxLjc3Niw4NCIsIjAuMjYiLCIxOCBEZWMgMjAyMyBhdCAyMDo1OTowMCIsIiQxLjc2OSw3NyIsIiQxLjc4Nyw2MCIsIjE0NDE5IiwNCiJpU2hhcmVzIENvcmUgUyZQIDUwMCBVQ0lUUyBFVEYiLCJJRTAwQjVCTVIwODciLCJHRVIiLCJVU0QiLCIkMzA4LDc1IiwiMS4zMCIsIjE4IERlYyAyMDIzIGF0IDA2OjIyOjUwIiwiJDEuNzY5LDc3IiwiJDEuNzg3LDYwIiwiMTQ0MTkiLA0KIlRTTEEgNS4zMDAlIDE1QXVnMjAyNSBDb3JwIChVU0QpIiwiVVNVODgxMExBQTE4IiwiWE5ZUyIsIlVTRCIsIiQzMDYsNjciLCI0LjMxIiwiMTggRGVjIDIwMjMgYXQgMDY6MjI6NTAiLCIkMS43NjksNzciLCIkMS43ODcsNjAiLCIxNDQxOSIs",
    "opstatus": 0,
    "httpStatusCode": "200"
}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Wealth FO
  • Transact
Enterprise API: NA

Field Mapping

UI Field Experience API Field Wealth FO API Field Transact Field
NA base64 NA NA
 
 
Description: This API retrieves list of watchlisted instruments.
Method: POST
URL: {{URL}}/services/data/v1/WealthOrder/operations/FavouriteInstruments/getFavoriteInstruments
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

portfolioId (Mandatory)

Specifies the ID field of the portfolio.

sortBy (Mandatory)

Specifies the sorting parameter.

sortOrder (Mandatory)

Specifies the order of sorting.

pageOffset (Mandatory)

Specifies the page offset.

pageSize (Mandatory)

Specifies the page size.

{ 
       "sortBy": "instrumentName",
    "sortOrder": "asc",
    "pageOffset": "0",
    "pageSize": "10",
    "portfolioId": ""

}
Response:

Parameters

/dateTime (Mandatory)

Specifies the date and time

/referenceCurrency (Mandatory)

Specifies the customer’s currency

/ISINCode (Mandatory)

Specifies the ISIN identifier

/netChange (Mandatory)

Specifies the net change

/instrumentId (Mandatory)

Specifies the instrument id

/percentageChange (Mandatory)

Specifies the percentage change

/formatDateTime (Mandatory)

Specifies the formatted date time

/bidRate (Mandatory)

Specifies the bidRate

/RIC (Mandatory)

Specifies the RIC code of the instrument

/volume (Mandatory)

Specifies the volume

/instrumentName (Mandatory)

Specifies the instrument name

/lastRate (Mandatory)

Specifies the lastRate

/application (Mandatory)

Specifies the application

/isSecurityAsset (Mandatory)

Specifies the security asset

/exchange (Mandatory)

Specifies the exchange value

/askRate (Mandatory)

Specifies the ask rate

{
    "favoriteInstruments": [
        {
            "dateTime": "2023-12-18T20:59:00",
            "referenceCurrency": "USD",
            "ISINCode": "US02079K1079",
            "netchange": "4.67",
            "instrumentId": "100027-000",
            "percentageChange": "0.26",
            "formatDateTime": "18 Dec 2023 at 20:59:00",
            "bidRate": "1769.77",
            "RIC": "GOOGL.O",
            "volume": 14419,
            "instrumentName": "Google LLC",
            "lastRate": "1776.84",
            "application": "SC",
            "dateReceived": "18 Dec 2023",
            "timeReceived": "20:59:00",
            "isSecurityAsset": true,
            "exchange": "NYSE",
            "askRate": "1787.6"
        },
        {
            "dateTime": "2023-12-18T06:22:50",
            "referenceCurrency": "USD",
            "ISINCode": "IE00B5BMR087",
            "netchange": "0.03",
            "instrumentId": "100093-000",
            "percentageChange": "1.30",
            "formatDateTime": "18 Dec 2023 at 06:22:50",
            "bidRate": "1769.77",
            "RIC": "BLK",
            "volume": 14419,
            "instrumentName": "iShares Core S&P 500 UCITS ETF",
            "lastRate": "308.75",
            "application": "SC",
            "dateReceived": "18 Dec 2023",
            "timeReceived": "06:22:50",
            "isSecurityAsset": true,
            "exchange": "GER",
            "askRate": "1787.6"
        },
        {
            "dateTime": "2023-12-18T06:22:50",
            "referenceCurrency": "USD",
            "ISINCode": "USU8810LAA18",
            "netchange": "1.66",
            "instrumentId": "100056-000",
            "percentageChange": "4.31",
            "formatDateTime": "18 Dec 2023 at 06:22:50",
            "bidRate": "1769.77",
            "RIC": "TSLA.OQ",
            "volume": 14419,
            "instrumentName": "TSLA 5.300% 15Aug2025 Corp (USD)",
            "lastRate": "306.67",
            "application": "SC",
            "dateReceived": "18 Dec 2023",
            "timeReceived": "06:22:50",
            "isSecurityAsset": true,
            "exchange": "XNYS",
            "askRate": "1787.6"
        }
    ],
    "opstatus_getFavoriteInstrumentsMock": 0,
    "opstatus": 0,
    "totalCount": 3,
    "httpStatusCode": "200"
}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Wealth FO
  • Transact
  • Refinitiv
Enterprise API:
  • v1.0.0/reference/instrumentDetails?code=$instrumentId
  • v1.0.0/reference/instruments?instrumentId=$instrumentId
  • /api/Quotes/Quotes.svc/REST/Quotes_1/RetrieveItem_3

Field Mapping

UI Field Experience API Field Wealth FO API Field Transact Field Refinitiv Field
Bid (Value only displayed in UI) bidRate     BID
Ask (Value only displayed in UI) askRate     ASK
Latest (Value only displayed in UI) lastRate extLastPriceN lastPrice CF_CLOSE
Exchange exchange marketThirdCode stockExchange CF_EXCHNG
Date /Time (Value only displayed in UI) dateTime     CF_DATE CF_TIME
Volume volume     CF_VOLUME
Change percentageChange     PCTCHNG
  netchange     CF_NETCHNG
ISIN ISINCode extIsinSynC ISIN ISIN_CODE
Instrument Name instrumentName name instrumentName CF_NAME
Currency referenceCurrency refCurrCode priceCurrency CF_CURRENCY
  instrumentId id instrumentId  
  RIC code alternateInstrumentId  
 
 
Description: This API retrieves the instrument data from market providers.
Method: POST
URL: {{URL}}/services/data/v1/WealthOrder/operations/ProductDetails/getProductDetails
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

RICCode (Mandatory)

Specifies the RIC code of the instrument.

{ 
      "RICCode": "AMZN.O"
}
Response:

Parameters

/instrumentName (Mandatory)

Specifies the name of the instrument

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/ISINCode (Mandatory)

Specifies the ISIN code of the instrument

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/netChange (Mandatory)

Specifies the difference between the closing price of a prior trading period and the current trading period of an instrument.

/percentageChange (Mandatory)

Specifies the percentage change in the latest trade price or value from the historic close

/dateReceived (Mandatory)

Specifies the date on which the price has been updated

/timeReceived (Mandatory)

Species the time at which the price has been updated

/exchange (Mandatory)

Specifies the stock exchange

/lastPrice (Mandatory)

Specifies the last trade price or value

/ST (Mandatory)

Specifies the status

/RT (Mandatory)

Specifies the news item revision item

/PR (Mandatory)

Specifies the news item provider

/LN (Mandatory)

Specifies the 2 letter language code

/TY (Mandatory)

Specifies the type such as Story, Alert, and Both

/LT (Mandatory)

Specifies the local time

/HT (Mandatory)

Specifies the news item headline

/CO (Mandatory)

Specifies the companies RICs

/CT (Mandatory)

Specifies the news item creation time

/RE (Mandatory)

Specifies the news item revision number

/AT (Mandatory)

Specifies the news attribution

/PD (Mandatory)

Specifies the products

/PE (Mandatory)

Specifies the PE values that can be multi-valued

/TN (Mandatory)

Specifies the Take Number to denote if a story is related to it exists

/ID (Mandatory)

Specifies the global unique ID

/TO (Mandatory)

Specifies the topics

/NI (Mandatory)

Specifies the named items

/UR (Mandatory)

Specifies the news item urgency

/totalCount (Mandatory)

Specifies the total records that are returned

/openRate (Mandatory)

Specifies the opening price of an instrument for the day

/volume (Mandatory)

Specifies the number of shares of an instrument traded during a given period of time

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/high52W (Mandatory)

Specifies the highest price of the instrument in the last 52-week time period

/low52W (Mandatory)

Specifies the lowest price of the instrument in the last 52-week time period

/latestRate (Mandatory)

Specifies the latest market price of an instrument

/bidRate (Mandatory)

Specifies the highest or the best price a buyer is willing to pay for an instrument

/bidVolume (Mandatory)

Specifies the quantity bid at the latest bid price

/askRate (Mandatory)

Specifies the lowest price for which someone is willing to sell a share

/askVolume (Mandatory)

Specifies the quantity offered at the latest ask price

{
    "opstatus_getInstruments": 0,
    "opstatus_getInstrumentDetails": 0,
    "opstatus_getDocuments": 0,
    "instrumentDetails": {
        "stockExchange": "NSQ",
        "marketPrice": "154.07",
        "instrumentName": "AMAZON COM",
        "referenceCurrency": "USD",
        "ISINCode": "US0231351067",
        "closeRate": "154.07",
        "netchange": "4.1",
        "percentageChange": "2.73",
        "dateReceived": "18 Dec 2023",
        "timeReceived": "21:00:00"
    },
    "opstatus": 0,
    "stockNews": [
        {
            "ST": "Usable",
            "RT": "2023-12-15T17:04:39-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-15T17:04:40-00:00",
            "HT": "US STOCKS-S&amp;P 500, Dow ease as Fed official&apos;s comments dampen rate-cut cheer",
            "CO": ".DJI .INX .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-15T17:04:39-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231215:nL4N3DA3LH",
            "TO": "TOPNWS RES AMERS RTRS BLR MKTREP CEN BACT INT MCE NAMER LEN NEWS1 STX TOPCMB PLCY REP US",
            "NI": "TOP/NEWS TOP/GLOMKT .N TOP/EQU TOP/CEN TOP/US",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-15T15:14:40-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-15T15:14:40-00:00",
            "HT": "US STOCKS-S&amp;P 500, Dow ease as Fed official&apos;s comments dampen rate-cut cheer",
            "CO": ".DJI .INX .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-15T15:14:40-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231215:nL4N3DA37Y",
            "TO": "AMERS LEN RTRS NEWS1 STX BLR MKTREP REP NAMER US",
            "NI": "TOP/GLOMKT TOP/NEWS .N TOP/CEN",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-11T17:17:08-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-11T17:17:09-00:00",
            "HT": "US STOCKS-S&amp;P, Nasdaq subdued on caution ahead of inflation data, Fed meeting",
            "CO": ".DJI 1YMcv1 .NDX .INX EScv1 NQcv1 .SPX .IXIC F1=0",
            "space": "preserve",
            "CT": "2023-12-11T17:17:08-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231211:nL4N3D630A",
            "TO": "TOPNWS AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 STX TOPCMB PLCY REP US",
            "NI": "TOP/NEWS TOP/GLOMKT .N TOP/EQU TOP/CEN TOP/US",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-11T15:34:22-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-11T15:34:23-00:00",
            "HT": "US STOCKS-S&amp;P, Nasdaq muted as markets brace for inflation data, Fed meeting",
            "CO": ".DJI 1YMcv1 .NDX .INX EScv1 NQcv1 .SPX .IXIC F1=0",
            "space": "preserve",
            "CT": "2023-12-11T15:34:22-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231211:nL4N3D62NH",
            "TO": "TOPNWS AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 STX TOPCMB PLCY REP US",
            "NI": "TOP/NEWS TOP/GLOMKT .N TOP/EQU",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-11T13:54:18-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-11T13:54:18-00:00",
            "HT": "US STOCKS-Wall St eyes muted open as markets brace for inflation data, Fed meeting",
            "CO": ".DJI 1YMcv1 .NDX .INX EScv1 NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-11T13:54:18-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231211:nL4N3D62CZ",
            "TO": "TOPNWS AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 STX TOPCMB PLCY REP US",
            "NI": "TOP/GLOMKT .N TOP/EQU .N/P",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-11T12:40:47-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-11T12:40:48-00:00",
            "HT": "US STOCKS-Futures muted as markets brace for inflation data, Fed meeting",
            "CO": ".DJI 1YMcv1 .INX EScv1 NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-11T12:40:47-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231211:nL4N3D621Y",
            "TO": "AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 STX PLCY REP US",
            "NI": ".N",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-11T11:22:50-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-11T11:22:50-00:00",
            "HT": "US STOCKS-Futures muted as traders brace for inflation data, Fed verdict",
            "CO": ".DJI 1YMcv1 .INX EScv1 NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-11T11:22:50-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231211:nL4N3D61VQ",
            "TO": "AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 STX PLCY REP US",
            "NI": ".N",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-07T21:21:02-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-07T21:21:02-00:00",
            "HT": "US STOCKS-Nasdaq ends sharply higher as Alphabet and AMD fuel AI surge",
            "CO": ".DJI .NDX MRK.N AMD.O GOOGL.O AMZN.O NVDA.O .SPLRCL .SOX AAPL.O TSLA.O .SPX .IXIC META.O",
            "space": "preserve",
            "CT": "2023-12-07T21:21:02-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC C RBR D MTL E GRO NAW ELN G MNI CGO SOF M O OIL T U RAST YDB MF",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231207:nL1N3D23AT",
            "TO": "CARM PHNE SOFW PHAR COMS SPCRET STX SHOPAL US ITSE CMPELC PHAR1 AMERS RTRS CMPNY SWIT PUBL HOT AUTO GEN TECH CHIP1 CYCS08 PHMR RGEN HECA PHAG08 RETE COMS08 SEMI BLR MDIA NETSV NAMER MPLT SHOP CHIP NEWS1 MAILOD DEPT PHONES CCOS ELEAV TECH08 ITSE08 TEEQ08 PHAR08 SRCHEN ECI MKTREP MCE MDIA08 LEN ARTI SCI CYCS TEEQ TMT REP SOCMED",
            "NI": ".N .N/C",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-07T21:00:29-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-07T21:00:30-00:00",
            "HT": "US STOCKS-Nasdaq ends sharply higher as Alphabet and AMD fuel AI surge",
            "CO": ".DJI .NDX AMZN.O NVDA.O MRK.N .SPLRCL AAPL.O .SPX .IXIC AMD.O GOOGL.O META.O",
            "space": "preserve",
            "CT": "2023-12-07T21:00:29-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC C RBR D MTL E GRO NAW ELN G MNI CGO SOF M O OIL T U RAST YDB MF",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231207:nL1N3D22ST",
            "TO": "PHNE SOFW PHAR COMS SPCRET STX SHOPAL US ITSE CMPELC PHAR1 AMERS RTRS CMPNY SWIT PUBL HOT GEN TECH CHIP1 CYCS08 PHMR RGEN HECA PHAG08 RETE COMS08 SEMI BLR MDIA NETSV NAMER MPLT SHOP CHIP NEWS1 MAILOD DEPT PHONES CCOS TECH08 ITSE08 TEEQ08 PHAR08 SRCHEN ECI MKTREP MCE MDIA08 LEN ARTI SCI CYCS TEEQ TMT REP SOCMED",
            "NI": ".N .N/C",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-07T19:37:19-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-07T19:37:21-00:00",
            "HT": "US STOCKS-Alphabet and AMD fuel AI rally on Nasdaq",
            "CO": ".DJI .NDX MRK.N AMD.O GOOGL.O AMZN.O NVDA.O .SPLRCL .SOX AAPL.O .SPX .IXIC META.O",
            "space": "preserve",
            "CT": "2023-12-07T19:37:19-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW ELN G DNP MNI M O T U RNP YDB MF PSC RBR CGO SOF PGE OIL RAST",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231207:nL1N3D22HA",
            "TO": "PHNE SOFW PHAR COMS SPCRET STX SHOPAL US ITSE CMPELC PHAR1 AMERS RTRS CMPNY SWIT PUBL TECH CHIP1 CYCS08 PHMR RGEN HECA PHAG08 RETE COMS08 SEMI BLR MDIA NETSV NAMER MPLT SHOP CHIP NEWS1 MAILOD DEPT PHONES CCOS TECH08 ITSE08 TEEQ08 PHAR08 SRCHEN ECI MKTREP MCE MDIA08 LEN CYCS TEEQ TMT REP SOCMED",
            "NI": ".N",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-07T16:51:44-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-07T16:51:45-00:00",
            "HT": "US STOCKS-Nasdaq outperforms on Alphabet boost, payrolls data in focus",
            "CO": ".DJI .NDX .INX .SPLRCL .SPX .IXIC GOOGL.O",
            "space": "preserve",
            "CT": "2023-12-07T16:51:44-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW G DNP M O T U RNP YDB MF EBX PSC RBR SOF PGE UKI OIL RAST",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231207:nL4N3D23V6",
            "TO": "TOPNWS BLR NETSV INT NAMER MPLT GDP NEWS1 STX TOPCMB PLCY TECH08 ITSE08 US ITSE AMERS RTRS CMPNY SRCHEN SWIT ECI MKTREP PUBL CEN MCE TECH LEN TMT REP",
            "NI": "TOP/GLOMKT TOP/NEWS .N TOP/EQU TOP/CEN TOP/US",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-07T14:58:13-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-07T14:58:13-00:00",
            "HT": "US STOCKS-Wall St rises on Alphabet boost, payrolls data in focus",
            "CO": ".DJI .NDX .INX .SPLRCL .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-07T14:58:13-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231207:nL4N3D23GO",
            "TO": "TOPNWS AMERS RTRS BLR ECI MKTREP CEN INT MCE NAMER MPLT LEN NEWS1 STX TOPCMB PLCY REP US",
            "NI": "TOP/GLOMKT TOP/NEWS .N TOP/US",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-06T21:30:12-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-06T21:30:14-00:00",
            "HT": "US STOCKS-Wall St ends lower as investors weigh fresh employment data",
            "CO": ".DJI CPB.N MSFT.O EScv1 MO.N BATS.L NQcv1 .SPLRCT 1YMcv1 AMZN.O NVDA.O PLUG.O PM.N .SPNY .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-06T21:30:12-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW ELN G DNP MNI M O T U RNP YDB MF PSC EMK RBR CGO SOF PGE UKI OIL RAST",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231206:nL1N3D13BM",
            "TO": "ENFF SOFW RENE RENQ SOFW1 STX FODPR1 SHOPAL US AMERS FODPR RTRS CMPNY SWIT SFCELL PUBL CEN EUROPE TECH CHIP1 CYCS08 ENER MTGFX RGEN WEU SEMI BLR CIGS CIGS1 INT NAMER MPLT SHOP CHIP NEWS1 FOTB MAILOD DEPT GB NCYC TECH08 BEVS EMEA TEEQ08 ECI MKTREP FOOOTH FOBE MCE LEN EUROP CYCS TEEQ TMT CIGARS LIQS REP",
            "NI": ".N .N/C",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-06T21:04:49-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-06T21:04:49-00:00",
            "HT": "REFILE-US STOCKS-S&amp;P 500 ends lower as investors weigh fresh employment data",
            "CO": ".DJI CPB.N MSFT.O EScv1 MO.N BATS.L NQcv1 1YMcv1 AMZN.O NVDA.O PLUG.O PM.N .SPNY .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-06T21:00:48-00:00",
            "RE": 2,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW ELN G DNP MNI M O T U RNP YDB MF PSC EMK RBR CGO SOF PGE UKI OIL RAST",
            "PE": "",
            "TN": 2,
            "ID": "urn:newsml:reuters.com:20231206:nL1N3D12ZQ",
            "TO": "TOPNWS ENFF SOFW RENE RENQ SOFW1 STX TOPCMB FODPR1 SHOPAL US AMERS FODPR RTRS CMPNY SWIT SFCELL PUBL CEN TECH CHIP1 CYCS08 ENER MTGFX RGEN WEU SEMI BLR CIGS CIGS1 INT NAMER MPLT SHOP CHIP NEWS1 FOTB MAILOD PLCY DEPT GB NCYC TECH08 BEVS EMEA TEEQ08 ECI MKTREP FOOOTH FOBE MCE LEN EUROP CYCS TEEQ TMT CIGARS LIQS REP",
            "NI": "TOP/NEWS TOP/GLOMKT .N .N/C TOP/CEN",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-06T16:52:52-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-06T16:52:53-00:00",
            "HT": "US STOCKS-Wall St inches up on rate cut hopes; energy weighs",
            "CO": ".DJI 1YMcv1 .INX AMZN.O EScv1 NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-06T16:52:52-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231206:nL4N3D13UK",
            "TO": "TOPNWS BLR INT NAMER MPLT SHOP NEWS1 STX TOPCMB MAILOD PLCY DEPT SHOPAL US AMERS RTRS CMPNY ECI MKTREP PUBL CEN MCE CYCS08 LEN MTGFX RGEN CYCS REP",
            "NI": "TOP/GLOMKT TOP/NEWS .N TOP/EQU TOP/CEN TOP/US",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-05T21:27:52-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-05T21:27:52-00:00",
            "HT": "US STOCKS-Wall Street ends mixed after job openings hint at cooling economy",
            "CO": ".DJI 1YMcv1 .INX EScv1 .RUT NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-05T21:27:52-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW ELN G DNP MNI M O T U RNP YDB MF PSC RBR CGO SOF PGE OIL RAST",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231205:nL1N3D02WZ",
            "TO": "AMERS RTRS BLR ECI MKTREP CEN INT MCE NAMER MPLT LEN NEWS1 MTGFX STX PLCY JOB REP US",
            "NI": ".N .N/C",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-05T21:00:35-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-05T21:00:36-00:00",
            "HT": "US STOCKS-Wall Street ends mixed after job openings hint at cooling economy",
            "CO": ".DJI 1YMcv1 .INX EScv1 .RUT NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-05T21:00:35-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW ELN G DNP MNI M O T U RNP YDB MF PSC RBR CGO SOF PGE OIL RAST",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231205:nL1N3D02K7",
            "TO": "AMERS RTRS BLR ECI MKTREP CEN INT MCE NAMER MPLT LEN NEWS1 MTGFX STX PLCY JOB REP US",
            "NI": ".N .N/C",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-05T19:14:49-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-05T19:14:50-00:00",
            "HT": "US STOCKS-Trading mixed after job openings hint at cooling economy",
            "CO": ".DJI 1YMcv1 .INX EScv1 .RUT NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-05T19:14:49-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PTD C D MTL E GRO NAW ELN G DNP MNI M O T U RNP YDB MF PSC RBR CGO SOF PGE OIL RAST",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231205:nL1N3D025I",
            "TO": "AMERS RTRS BLR ECI MKTREP CEN INT MCE NAMER MPLT LEN NEWS1 MTGFX STX PLCY REP US",
            "NI": ".N",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-05T17:09:39-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-05T17:09:40-00:00",
            "HT": "US STOCKS-Wall St mixed as traders assess economic data, megacaps rebound",
            "CO": ".DJI 1YMcv1 .INX EScv1 .RUT NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-05T17:09:39-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231205:nL4N3D03DW",
            "TO": "TOPNWS AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 MTGFX STX TOPCMB PLCY REP US",
            "NI": "TOP/NEWS TOP/GLOMKT .N TOP/EQU TOP/CEN TOP/US",
            "UR": 3
        },
        {
            "ST": "Usable",
            "RT": "2023-12-05T14:05:21-00:00",
            "PR": "reuters.com",
            "LN": "en",
            "TY": "story",
            "LT": "2023-12-05T14:05:22-00:00",
            "HT": "US STOCKS-Wall St eyes lower open as focus shifts to jobs data",
            "CO": ".DJI 1YMcv1 .INX EScv1 NQcv1 .SPX .IXIC",
            "space": "preserve",
            "CT": "2023-12-05T14:05:21-00:00",
            "RE": 1,
            "AT": "RTRS",
            "PD": "NAT PSC PTD C RBR D MTL E GRO G DNP SOF M O PGE UKI OIL T U RNP RAST YDB MF EBX",
            "PE": "",
            "TN": 1,
            "ID": "urn:newsml:reuters.com:20231205:nL4N3D02JC",
            "TO": "TOPNWS AMERS RTRS BLR MKTREP CEN INT MCE NAMER LEN NEWS1 STX TOPCMB PLCY REP US",
            "NI": "TOP/NEWS TOP/GLOMKT .N TOP/EQU .N/P TOP/US",
            "UR": 3
        }
    ],
    "totalCount": 20,
    "pricingDetails": {
        "openRate": "150.56",
        "volume": 62512828,
        "referenceCurrency": "USD",
        "closeRate": "154.07",
        "high52W": "150.57",
        "low52W": "81.43",
        "latestRate": "154.07",
        "bidRate": "153.91",
        "bidVolume": 2,
        "askVolume": 44,
        "askRate": "153.93"
    },
    "opstatus_getPricingData": 0,
    "opstatus_getNews": 0,
    "opstatus_getStockNews": 0,
    "httpStatusCode": "200"
}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Wealth FO
  • Transact
  • Refinitiv
Enterprise API:

Refinitiv:

  • Quotes/Quotes.svc/REST/Quotes_1/RetrieveItem_3
  • "CF_CURRENCY:CF_EXCHNG:ISIN_CODE:CF_NAME:TRDPRC_1:PCTCHNG: CF_CLOSE:CF_NETCHNG:CF_DATE:CF_TIME"
  • CF_BID:BIDSIZE:CF_ASK:ASKSIZE:CF_VOLUME:CF_OPEN:CF_CLOSE:52WK_HIGH:52WK_LOW:CF_LAST:CF_CURRENCY"
  • News/News.svc/REST/News_1/RetrieveHeadlineML_1

Field Mapping

UI Field Experience API Field Refinitiv Field
ISIN (Value only displayed in UI) ISINCode ISIN_CODE
Instrument Name (Value only displayed in UI) InstrumentName CF_NAME
Exchange (Value only displayed in UI) Exchange CF_EXCHNG
Currency Symbol (Value only displayed in UI) ReferenceCurrency CF_CURRENCY
Price (Value only displayed in UI) LastPrice TRDPRC_1
NetChange (Value only displayed in UI) NetChange CF_NETCHNG
Percentage Change (Value only displayed in UI) PercentageChange PCTCHNG
Last Updated on DateReceived CF_DATE
Last Updated on TimeReceived CF_TIME
Price (Value only displayed in UI) CloseRate CF_CLOSE
NA ST ST
News Time (Value only displayed in UI) RT RT
News Provider (Value only displayed in UI) PR PR
NA LN LN
NA TY TY
Currency Symbol (Value only displayed in UI) ReferenceCurrency CF_CURRENCY
Bid BidRate CF_BID
Bid Vol BidVolume BIDSIZE
Ask AskRate CF_ASK
Ask Vol AskVolume ASKSIZE
Open OpenRate CF_OPEN
Close CloseRate CF_CLOSE
Volume Volume CF_VOLUME
52W High High52W 52WK_HIGH
52 Low Low52W 52WK_LOW
Latest LatestRate CF_LAST
 
 
Description: This API retrieves the instrument data and its asset details.
Method: POST
URL: {{URL}}/services/data/v1/WealthOrder/operations/ProductDetails/getProductDetailsFromId
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

RICCode (Mandatory)

Specifies the RIC code of the instrument.

ISINCode (Mandatory)

Specifies the ISIN code of the instrument

instrumentId (Mandatory)

Specifies the id of the instrument

application (Mandatory)

Specifies the RIC code of the instrument.

{ 
         "ISINCode": "ISINCode",
    "RICCode": "AMZN.O",
    "instrumentId": "100046-000",
    "application": "SC"

}
Response:

Parameters

/instrumentName (Mandatory)

Specifies the name of the instrument

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/ISINCode (Mandatory)

Specifies the ISIN code of the instrument

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/netChange (Mandatory)

Specifies the difference between the closing price of a prior trading period and the current trading period of an instrument.

/percentageChange (Mandatory)

Specifies the percentage change in the latest trade price or value from the historic close

/dateReceived (Mandatory)

Specifies the date on which the price has been updated

/timeReceived (Mandatory)

Species the time at which the price has been updated

/exchange (Mandatory)

Specifies the stock exchange

/openRate (Mandatory)

Specifies the opening price of an instrument for the day

/volume (Mandatory)

Specifies the number of shares of an instrument traded during a given period of time

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/high52W (Mandatory)

Specifies the highest price of the instrument in the last 52-week time period

/low52W (Mandatory)

Specifies the lowest price of the instrument in the last 52-week time period

/latestRate (Mandatory)

Specifies the latest market price of an instrument

/bidRate (Mandatory)

Specifies the highest or the best price a buyer is willing to pay for an instrument

/bidVolume (Mandatory)

Specifies the quantity bid at the latest bid price

/askRate (Mandatory)

Specifies the lowest price for which someone is willing to sell a share

/askVolume (Mandatory)

Specifies the quantity offered at the latest ask price

/country (Mandatory)

The country which the stock belongs to.

/region (Mandatory)

Specifies the instrument domicile

/assetType (Mandatory)

The type of the asset class that the instrument belong to.

/isSecurityAsset (Mandatory)

Specifies whether the instrument is a securities type of an asset

/interestRate (Mandatory)

Specifies the interest rate of the asset instrument.

/duration (Mandatory)

The total duration or tenure of the instrument. The tenure of the bond is from the Issue date till the Maturity date.

/maturityDate (Mandatory)

The date in which the bond matures.

/rating (Mandatory)

Specifies the rating of the asset instrument

/nxtCouponDate (Mandatory)

The date in which the next coupon/interest is paid to the bond holders.

/modifiedDuration (Mandatory)

This specifies the change in the value of a security based on the change in interest rates

/type (Mandatory)

This specifies the type of the fund, whether it is a normal fund or Exchange Traded Fund (ETF)

/sector (Mandatory)

Specifies the industry

/issuer (Mandatory)

This specifies who issues the instrument.

/expiryDate (Mandatory)

This specifies the expiry date of the contract.

/contractSize (Mandatory)

This specifies the quantity and in multiples thereof in which the transactions can be executed.

/underlying (Mandatory)

Underlying are the financial assets based on which the derivatives' price is determined.

/optionStyle (Mandatory)

This specifies the style of an option (American or European etc..)

/optionClass (Mandatory)

This specifies the option class (Call or Put)

/strikePrice (Mandatory)

This specifies the price at which the options can be exercised

 {
    "opstatus_getInstruments": 0,
    "instrumentAssets": {
        "assetTypes": {
            "country": "US",
            "region": "North America",
            "sector": "Other Sectors",
            "assetType": "Stock"
        },
        "isSecurityAsset": true
    },
    "opstatus_getProductDetails": 0,
    "opstatus_getDocuments": 0,
    "opstatus_getSynonyms": 0,
    "opstatus_getInstrumentMinimal": 0,
    "productDetails": {
        "stockExchange": "NSM",
        "marketPrice": "154.07",
        "referenceCurrency": "USD",
        "quantity": "",
        "ISINCode": "US0231351067",
        "netchange": "4.1",
        "instrumentId": "100046-000",
        "percentageChange": "2.73",
        "isinExchange": "US0231351067 | NSM",
        "assetType": "Stock",
        "formatted_netperChange": "+4.1 (+2.73%)",
        "instrumentName": "Amazon.com",
        "application": "SC",
        "dateReceived": "18 Dec 2023",
        "RICCode": "AMZN.OQ",
        "timeReceived": "21:00:00",
        "isSecurityAsset": "true",
        "instrumentCurrencyId": "USD"
    },
    "opstatus_getNews": 0,
    "opstatus_getInstrumentDetails": 0,
    "instrumentMinimal": [
        {
            "stockExchange": "MKT_NYSE",
            "marketPrice": "150",
            "instrumentName": "Amazon.com",
            "referenceCurrency": "USD",
            "quantity": "",
            "ISINCode": "US0231351067",
            "instrumentId": "100046-000",
            "dateReceived": "",
            "RICCode": "AMZN.OQ",
            "id": "5431",
            "instrumentCurrencyId": "USD"
        }
    ],
    "instrumentDetails": {
        "stockExchange": "NSM",
        "marketPrice": "154.07",
        "instrumentName": "AMAZON COM",
        "referenceCurrency": "USD",
        "ISINCode": "US0231351067",
        "closeRate": "154.07",
        "netchange": "4.1",
        "percentageChange": "2.73",
        "dateReceived": "18 Dec 2023",
        "timeReceived": "21:00:00"
    },
    "opstatus": 0,
    "id": "5431",
    "pricingDetails": {
        "openRate": "150.56",
        "volume": 13399413,
        "referenceCurrency": "USD",
        "closeRate": "154.07",
        "high52W": "150.55",
        "low52W": "81.44",
        "latestRate": "154.07",
        "bidRate": "153.65",
        "bidVolume": 1,
        "askVolume": 1,
        "askRate": "153.95"
    },
    "opstatus_getPricingData": 0,
    "opstatus_getStockNews": 0,
    "httpStatusCode": 200,
    "status": "success"
}

Parameters

/instrumentName (Mandatory)

Specifies the name of the instrument

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/ISINCode (Mandatory)

Specifies the ISIN code of the instrument

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/netChange (Mandatory)

Specifies the difference between the closing price of a prior trading period and the current trading period of an instrument.

/percentageChange (Mandatory)

Specifies the percentage change in the latest trade price or value from the historic close

/dateReceived (Mandatory)

Specifies the date on which the price has been updated

/timeReceived (Mandatory)

Species the time at which the price has been updated

/exchange (Mandatory)

Specifies the stock exchange

/openRate (Mandatory)

Specifies the opening price of an instrument for the day

/volume (Mandatory)

Specifies the number of shares of an instrument traded during a given period of time

/referenceCurrency (Mandatory)

Specifies the currency in which the instrument is quoted

/closeRate (Mandatory)

Specifies the closing price of an instrument for the day

/high52W (Mandatory)

Specifies the highest price of the instrument in the last 52-week time period

/low52W (Mandatory)

Specifies the lowest price of the instrument in the last 52-week time period

/latestRate (Mandatory)

Specifies the latest market price of an instrument

/bidRate (Mandatory)

Specifies the highest or the best price a buyer is willing to pay for an instrument

/bidVolume (Mandatory)

Specifies the quantity bid at the latest bid price

/askRate (Mandatory)

Specifies the lowest price for which someone is willing to sell a share

/askVolume (Mandatory)

Specifies the quantity offered at the latest ask price

/country (Mandatory)

The country which the stock belongs to.

/region (Mandatory)

Specifies the instrument domicile

/assetType (Mandatory)

The type of the asset class that the instrument belong to.

/isSecurityAsset (Mandatory)

Specifies whether the instrument is a securities type of an asset

 {
    "opstatus_getInstruments": 0,
    "instrumentAssets": {
        "assetTypes": {
            "country": "US",
            "region": "AMERICA",
            "sector": "RETAILERS",
            "assetType": "Stock"
        },
        "isSecurityAsset": true
    },
    "opstatus_getProductDetails": 0,
    "opstatus_getDXAssetTypes": 0,
    "opstatus_getAssetTypes": 0,
    "opstatus_getDocuments": 0,
    "opstatus_getSCAssetTypes": 0,
    "opstatus_getInstrumentMinimal": 0,
    "totalCount": 0,
    "productDetails": {
        "stockExchange": "NYSE",
        "marketPrice": "100.42",
        "referenceCurrency": "USD",
        "quantity": "1",
        "ISINCode": "US0231351067",
        "netchange": "",
        "instrumentId": "100046-000",
        "percentageChange": "",
        "isinExchange": "US0231351067 | NYSE",
        "assetType": "Stock",
        "formatted_netperChange": " ",
        "instrumentName": "Amazon.com",
        "application": "SC",
        "dateReceived": "18 Apr 2023",
        "RICCode": "",
        "timeReceived": "",
        "isSecurityAsset": "true",
        "instrumentCurrencyId": "USD"
    },
    "opstatus_getNews": 0,
    "opstatus_getDXMasterAssetTypes": 0,
    "opstatus_getInstrumentDetails": 0,
    "Field": [],
    "instrumentMinimal": [
        {
            "stockExchange": "NYSE",
            "instrumentName": "Amazon.com",
            "marketPrice": "100.42",
            "referenceCurrency": "USD",
            "quantity": "1",
            "ISINCode": "US0231351067",
            "instrumentId": "100046-000",
            "dateReceived": "18 Apr 2023",
            "RICCode": "",
            "instrumentCurrencyId": "USD"
        }
    ],
    "opstatus": 0,
    "stockNews": [],
    "opstatus_getPricingData": 0,
    "opstatus_getStockNews": 0,
    "httpStatusCode": 200,
    "status": "success"
}
Error Code(s): Error Message: Unauthorized Access.
Enterprise Provider:
  • Wealth FO
  • Transact
  • Refinitiv
Enterprise API:

Wealth FO:

  • getInstrumentMinimal: v1.0.0/reference/instruments/$instrumentId
  • getSynonyms:v1.0.0/reference/synonyms?objectId=$id

Transact:

  • getInstrumentMinimal: {base_url}/ v1.0.0/reference/instruments?instrumentId=$instrumentId
  • getSCAssetTypes: v1.1.0/reference/instruments?instrumentId=$instrumentId
  • getDXAssetTypes:v1.1.0/reference/instruments/derivativeInstrument?$param=$instrumentId
  • getDXMasterAssetTypes:v1.1.0/reference/instruments/derivativeContractMaster?$param=$instrumentId

Refinitiv:

  • Quotes/Quotes.svc/REST/Quotes_1/RetrieveItem_3
  • "CF_CURRENCY:CF_EXCHNG:ISIN_CODE:CF_NAME:TRDPRC_1:PCTCHNG: CF_CLOSE:CF_NETCHNG:CF_DATE:CF_TIME"
  • CF_BID:BIDSIZE:CF_ASK:ASKSIZE:CF_VOLUME:CF_OPEN:CF_CLOSE:52WK_HIGH:52WK_LOW:CF_LAST:CF_CURRENCY"
  • News/News.svc/REST/News_1/RetrieveHeadlineML_1

Field Mapping

UI Field Experience API Field Wealth FO Field Transact Field Refinitiv API Field
ISIN (Value only displayed in UI) ISINCode     ISIN_CODE
Instrument Name (Value only displayed in UI) InstrumentName     CF_NAME
Exchange (Value only displayed in UI) Exchange     CF_EXCHNG
Currency Symbol (Value only displayed in UI) ReferenceCurrency     CF_CURRENCY
Price (Value only displayed in UI) LastPrice     TRDPRC_1
NetChange (Value only displayed in UI) NetChange     CF_NETCHNG
Percentage Change (Value only displayed in UI) PercentageChange     PCTCHNG
Last Updated on DateReceived     CF_DATE
Last Updated on TimeReceived     CF_TIME
Price (Value only displayed in UI) CloseRate     CF_CLOSE
Currency Symbol (Value only displayed in UI) ReferenceCurrency     CF_CURRENCY
Bid BidRate     CF_BID
Bid Vol BidVolume     BIDSIZE
Ask AskRate     CF_ASK
Ask Vol AskVolume     ASKSIZE
Open OpenRate     CF_OPEN
Close CloseRate     CF_CLOSE
Volume Volume     CF_VOLUME
52W High High52W     52WK_HIGH
52 Low Low52W     52WK_LOW
Latest LatestRate     CF_LAST
Exchange ( Value only displayed in UI) StockExchange MarketThirdCodeange    
NA InstrumentID Code instrumentId  
ISIN (Value only displayed in UI) ISINCode ExtIsInSynC ISIN  
Last Updated On LastPriceDate   lastPriceDate  
Instrument Name InstrumentName Name instrumentName  
Instrument Currency Symbol PriceCurrency RefCurrCode priceCurrency  
Quantity (Current Position Card) Quantity   tradingUnits  
Instrument Currency Symbol InstrumentCurrencyID RefCurrCode instrumentCurrencyId  
Last Price (Value displayed in UI) LastPrice ExtLastPriceN lastPrice  
NA RICCode code alternateInstrumentId  
Region Region Region domicileRegion  
Next Coupon Date NxtCoupnDate FirstCoupD initialPaymentDate  
Interest Rate InterestRate InterestRateP interestRate  
Maturity Date, Expiry Date MaturityDate,ExpiryDate   maturityDate  
Duration Duration ExtDuration duration  
Rating Rating ExtRatingC bondRating  
Issuer Issuer IssuerThirdDenom issuer  
Type Type TypeName tradeType  
Underlying Underlying UnderlyInstrDenom instrumentName  
Contract Size ContractSize ContractSizeN contractSize  
Contract Type ContractType ContractTypeName tradeType  
Country Country TaxGeoCode instrumentDomicile  
Sector Sector ExtSectorDenom industryName  
Option Style OptionStyle OptStyleE optionStyle  
Option Class OptionClass OptionClassE callOrPut  
Strike Price StrikePrice ExerQuoteN strikePrice  
 
 
 
Parameter Name DataType Description
currencyPairs String Specifies the exchange rate for the currency pair.
marketRate String Specifies the market rate.
ID String  Specifies the ID.
dateOrPeriod String  Specifies the date.
RICCode String Specifies the RICCODE of the instrument.
instrumentId String Specifies the instrument id of the instrument.
 
Parameter Name DataType Description
ISINCode String Specifies the portfolio ID of the customers portfolio.
 
Parameter Name DataType Description
portfolioId String Specifies the ID of the customers portfolio.
navPage String This parameter is used to set the field names and retrieve the response from the respected services.
sortBy String Specifies the field on which the sort needs to be performed.
searchByInstrumentName String Specifies the value on which the search needs to be performed.
startDate String Specifies the date from when the records are to be retrieved for the customer.
endDate String Specifies the date until when the records are to be retrieved for the customer.
accountId String Specifies the account ID of the customer (for account activity report).
dateFrom String Specifies the date from when the records are to be retrieved for the customer.
dateTo String Specifies the date until when the records are to be retrieved for the customer.
listType String Specifies the type of list to be fetched.
currencyId String Specifies the reference currency of the customer.
benchMarkIndex String Specifies the market indices created by using multiple instruments of the market/sector.
duration String Specifies the time period.
type String Specifies the type of orders to be fetched.
orderId String Specifies the order reference ID of the order.
isEuro String Specifies whether the currency is euro.
instrumentId String Specifies the ID of the instrument
sortOrder String Specifies the order used for sorting such as ascending or descending.
 
Parameter Name DataType Description
ID String Specifies the ID of the instrument.
userID String Specifies the user Id of the customer.
customerID String Specifies the customer ID.
favInstrumentCodes String Specifies the Favorite instruments RICCode.
RICCode String Specifies the RICCode.
operation String Specifies the operation (add/remove/update).
favInstrumentID's String Specifies the comma seperated instrument ID's.
instrumentID String Specifies the ID of instrument.
 
Parameter Name DataType Description
RICCode String Specifies the RICCODE of the instrument, which is used to get data from Refinitiv.
 
Parameter Name DataType Description
instrumentId String Specifies the Instrument Id of the Instrument.
 
Parameter Name DataType Description
sellAmount String Specifies the total estimated sell amount for the order.
buyAmount String Specifies the total estimated buy amount for the order.
sellCurrency String Specifies the sell currency. 
buyCurrency String Specifies the buy currency. 
ISINCode String Specifies the ISIN code of the instrument.
marketPrice String Specifies the market price of the instrument. 
order String Used for internal purpose. 
quantity String Specifies the quantity of the order placed. 
orderType String Specifies the order type (Market/Limit/Stop Loss/Stop Limit).
stopLoss String Specifies the stop loss price at which the order has been placed. 
stopPrice String Specifies the stop limit price at which the order has been placed. 
limitPrice String Specifies the limit price at which the order has been placed. 
validity String Specifies the validity of the order (Day/GTC order). 
netAmount String Specifies the estimated amount of the order.
portfolioID String Specifies the portfolio id of the customer. 
customerId String Specifies the customer id of the customer.
stockExchange String Specifies the Stock Exchange at which the instrument has been listed. 
tradeCurrency String Specifies the trade currency of the order/transaction. 
instrumentID String Specifies the instrument ID of the instrument. 
price String Specifies the instrument market price.
transactionType String Specifies the transaction type of the order (Buy/Sell).
orderId String Specifies the Transact / Wealth FO Order ID of the order placed. 
validate_only String Specifies the operation to validate the order to receive override/error etc. 
calculateCharges String Specifies the operation to calculate the charges for the order.
dealStatus String his parameter must be set to TRANSMITTED for a new order.
caseCode String Specifies the case code.
orderTypeCode String Specifies the order type code. 
reasonC String Specifies the case reason. 
targetNatureE String Specifies the nature. 
funcResultCode String Specifies the result code. 
 
Parameter Name DataType Description
portfolioID String Specifies the portfolio ID of the customer.
searchByInstrumentName String Specifies the value on which the search needs to be performed.
type String Specifies the type of order.
startDate String Specifies the date from when the records are to be retrieved for the customer.
endDate String Specifies the date until when the records are to be retrieved for the customer.
sortBy String Specifies the field on which the sort needs to be performed.
orderID String Specifies the Transact/Wealth FO Order Id of the order placed. 
sortOrder String Specifies the order used for sorting such as ascending or descending.
pageSize String Specifies the number of records to be returned. 
pageOffset String Specifies the index of the starting record. 
instrumentID String Specifies the instrument ID.
assetType String Specifies the asset type of the instrument.
 
Parameter Name DataType Description
portfolioID String Specifies the portfolio ID of the customer.
portfolioName String Specifies the portfolio name of the customer. 
referenceCurrency String Specifies the reference currency of the portfolio. 
marketValue String Specifies the market value of the portfolio in the portfolio reference currency. 
unRealizedPL String Specifies the unrealized PL.
unRealizedPLAmount String Specifies the unrealized PL of the portfolio in the portfolio reference currency. 
unRealizedPLPercentage String Specifies the unrealized PL percentage change of the portfolio. 
todayPL String Specifies the today PL. 
todayPLAmount String Specifies the today PL of the portfolio in the portfolio reference currency. 
todayPLPercentage String Specifies the today PL percentage of the portfolio. 
assetGroup String Specifies the asset type of the instrument. 
graphDuration String Specifies the duration for which the graph to be displayed.
navPage String Specifies the page from which service is being called.
totalCashBalance String Specifies the total cash balance of the portfolio in portfolio reference currency. 
currency String Specifies the  currency of the account linked to the portfolio.
balance String Specifies the account balance in the account currency. 
accountName String Specifies the account name. 
totalCashBalanceCurrency String Specifies the total cash balance in the portfolio reference currency.
totalMarketValue String Specifies the total market value in the portfolio reference currency. 
TIMESTAMP String Specifies the date and time for instrument graph.
AMOUNT String Specifies the instrument price for instrument graph. 
PERCENTAGE String Specifies the percentage change for instrument graph.
currencyName String Specifies the currency.
accountNumber String Specifies the account number of the account linked to the portfolio. 
investmentType String Specifies the investment type.
customerId String Specifies the customer Id of the customer.
referenceCurrencyValue String Specifies the value in reference currency. 
ricCodes String Specifies the RICCODE of the instrument which is used to get data from Refinitiv.
searchByInstrumentName String Specifies the value on which the search needs to be performed.
sortBy String Specifies the field on which the sort needs to be performed.
sortOrder String Specifies the order used for sorting such as ascending or descending.
pageSize String Specifies the number of records to be returned.
pageOffset String Specifies the index of the starting record. 
userID String Specifies the user ID. 
totalCount String Specifies the total count.
 
Parameter Name DataType Description
portfolioID String Specifies the portfolio Id of the portfolio.
description String Specifies the portfolio name. 
holdingsType String Specifies the type of holdings. 
quantity String Specifies the quantity of instrument available in the portfolio. 
marketPrice String Specifies the current market price of the instrument. 
costPrice String Specifies the cost price of the instrument. 
marketValue String Specifies the current market value of the instrument.
unrealPLMkt String Specifies the unrealized PL of the instrument. 
secCCy String Specifies the security/instrument currency. 
navPage String Specifies the page from which service is being called. 
ISIN String Specifies the ISIN of the instrument. 
sortBy String Specifies the field on which the sort needs to be performed. 
searchByInstrumentName String Specifies the value on which the search needs to be performed.
holdingsID String Specifies the ID (Internal) of the instrument.
transactionId String Specifies the transaction ID (Transact/Wealth FO) of the transaction.
orderType String Specifies the order type of the transaction. 
exchangeRate String Specifies the exchange rate between security currency vs portfolio reference currency. 
limitPrice String Specifies the price at which the transaction had taken place. 
netAmount String Specifies the net amount of the transaction. 
tradeDate String Specifies the trade date of the transaction. 
fees String Specifies the fees involved in the transaction. 
valueDate String Specifies the value date of the transaction. 
referenceCurrency String Specifies the reference curreny of the portfolio. 
startDate String Specifies the date from when the records are to be retrieved for the customer.
endDate String Specifies the date until when the records are to be retrieved for the customer.
instrumentId String Specifies the Instrument Id of the instrument 
RICCode String Specifies the RICCODE of the instrument, which is used to get data from Refinitiv. 
customerId String Specifies the customer Id of the customer 
instrumentCurrency String Specifies the security currency / instrument currency of the instrument. 
instrumentAmount String Specifies the transaction amount in the security currency / instrument currency. 
total String Specifies the total amount of the transaction. 
sortType String Specifies the field on which the sort needs to be performed.
userID String Specifies the User Id of the User. 
fieldOrder String Specifies the field order which user have chosen. 
limit String Used for internal purpose.
offset String Used for internal purpose.
sortOrder String Specifies the order used for sorting such as ascending or descending. 
pageSize String Specifies the number of records to be returned. 
pageOffset String Specifies the index of the starting record. 
accountIDs String Specifies the account Id of the account.
instrumentType String Specifies the type of instrument.
 
Parameter Name DataType Description
RICCode String Specifies the RICCode.
 
Parameter Name DataType Description
ISINCode String Specifies the ISIN code of the instrument.
RICCode String Specifies the RICCODE of the instrument.
instrumentID String Specifies the instrument Id of the instrument.
 
Parameter Name DataType Description
RICCode String Specifies the RICCODE of the instrument.
pageSize String Specifies the number of records to be returned.
pageOffset String Specifies the index of the starting record.
StoryID String Specifies the news story iD.

 

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Thursday, May 30, 2024 11:38:30 AM IST