Order Management

Name	Description	Introduced In
getSearchInstrumentList	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
getPortfolioHoldings	This API retrieves the list of holdings for a particular portfolio and performs operations such as search, sort, and pagination.	2021.04
getStockNews	This API retrieves the stock news for the specified RIC code of the instrument.	2021.04
getHistoricalData	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
getDocuments	This API displays the URL of the available document.	2021.04
viewInstrumentTransactions	This API retrieves the list of instruments based on the search value.	2021.07
createMarketOrder	This API places a new order of the selected type such as Market, Limit, Stop Loss, and Stop Limit.	2021.04
modifyOrder	This API modifies the existing order.	2021.04
cancelOrder	This API cancels the order that is placed for either buying or selling.	2021.04
getCashAccounts	This API retrieves the list of cash accounts and their balances.	2021.04
getAddCurrency	This API retrieves the list of currencies.	2021.04
getMarketRates	This API retrieves the market rates for the currency pairs.	2021.04
getUserFavouriteInstruments	This API retrieves the favorite instruments of the user.	2021.04
updateUserFavouriteInstruments	This API updates the favorite instruments of the user.	2021.04
createorder	This API creates a forex order.	2021.04
getstockNewsDetails	This API retrieves the stock news headlines and details.	2021.04
getStockNewsStory	This API retrieves the news story for the given news ID.	2021.04
Object Data Model s	This Object Data Model describes the parameter name and other attribute details for Order Management

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

getSearchInstrumentList

Description:

This API retrieves the list of instruments based on the search value.

Method:

GET

URL:

services/data/v1/WealthOrder/operations/InstrumentDetails/getSearchInstrumentList

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:

Wealth FO

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

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

getInstrumentMinimal

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:

Transact

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"

}

Wealth FO

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

getInstrumentDetails

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

getPortfolioHoldings

Description:

This API retrieves the list of holdings for a particular portfolio, and performs operations such as search, sort, and pagination.

Method:

POST

URL:

{{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getPortfolioHoldings

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

navPage (Mandatory)

This parameter is used to download the field names

sortBy (Mandatory)

Specifies the field on which the sort needs to be performed

/userId (Optional)

Specifies the customer ID

/fieldOrder (Optional)

Specifies the order of the fields

sortOrder (Optional)

Specifies the order used for sorting such as ascending or descending

pageSize (Optional)

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

pageOffset (Optional)

Specifies the index of the starting record

isEuro (Optional)

Specifies whether the currency is Euro or not

{
    "portfolioId": "100285-1",
    "userId": 7312057965,
    "fieldOrder": "fieldOrder",
    "navPage": "Holdings",

    "sortBy": "description",
    "pageSize": 10,
    "pageOffset": 0,
    "sortOrder": "ASC",
    "isEuro": "isEuro"
}

Response:

Transact

Parameters

/portfolioID (Mandatory/)

Specifies the ID field of the customer’s portfolio

/referenceCurrency (Mandatory)

Specifies the customer’s currency

/accountName (Mandatory)

Specifies the portfolio name

/accountNumber (Mandatory)

Specifies the ID field of the customer’s portfolio

/marketValue (Mandatory)

Specifies the total value of the portfolio holdings

/fieldstoDisplay (Mandatory)

Specifies the fields to display

/marketPrice (Mandatory)

Specifies the latest price

/marketValPOS (Mandatory)

Specifies the estimation

/quantity (Mandatory)

Specifies the number of stocks that are bought

/costValue (Mandatory)

Specifies the cost value of the holdings in the reference currency

/assestClass (Mandatory)

Specifies the type of holdings

/costPrice (Mandatory)

Specifies the average cost of the holding

/weightPercentage (Mandatory)

Specifies the weightage of the holdings

/costValueSecCcy (Mandatory)

Specifies the cost value in security currency

/description (Mandatory)

Specifies the name of the instrument

/marketValue (Mandatory)

Specifies the estimated value of the asset

/ISIN (Mandatory)

Specifies the ISIN code of the instrument

/unrealizedProfitLossSecCcy (Mandatory)

Specifies the unrealized profit or loss in security currency

/unRealizedPLPercentage (Mandatory)

Specifies the percentage change in the current profit or loss on any open positions

/holdingsId (Mandatory)

Specifies the instrument ID

/secCCy (Mandatory)

Specifies the instrument currency

/unrealPLMkt (Mandatory)

Specifies the current profit or loss on any open positions

/isSecurityAsset (Mandatory)

Specifies whether the instrument is a securities type of an asset

/region (Mandatory)

Specifies the instrument domicile

/sector (Mandatory)

Specifies the industry

/holdingsType (Mandatory)

Specifies the stock exchange

{


    "referenceCurrency": "GBP",

    "accountName": "David Sainsbury Portfolio 1",

    "marketValue": "1889857.27",

    "accountNumber": "100273-1",

    "totalCount": 10,

    "opstatus_getHoldingsList": 0,

    "portfolioID": "100273-1",

    "fieldstoDisplay": "holdingsId, holdingsType, marketPrice, ISIN, marketValPOS, weightPercentage, unrealPLMkt, region, assestClass, sector, secCCy, marketValue, costValue, unRealizedPLPercentage, quantity,costPrice, description, costValueSecCcy, unrealizedProfitLossSecCcy,unrealizedProfitLossPercentageSecCcy",

    "portfolioHoldings": [

    

        {

            "marketPrice": "131.4598",

            "marketValPOS": "1,314.60",

            "quantity": "1000",

            "costValue": "103502",

            "assestClass": "Bonds",

            "costPrice": "144.655",

            "weightPercentage": "0.00",

            "costValueSecCcy": "144655",

            "description": "Us Treasury Note 5.40 Pct 2023",

            "marketValue": "940.61",

            "ISIN": "US912828ST86",

            "unrealizedProfitLossSecCcy": "-128340.4",

            "unRealizedPLPercentage": "0.00",

            "holdingsId": "300500-006",

            "secCCy": "USD",

            "unrealPLMkt": "12.9",

            "isSecurityAsset": true,

            "unrealizedProfitLossPercentageSecCcy": "-88.70",

            "region": "US",

            "sector": "BANK",

            "holdingsType": "OTC1",

  “exchangeRate”:”1.26”

        },

        {

            "marketPrice": "204.349",

            "marketValPOS": "1,021.75",

            "quantity": "500",

            "costValue": "83840",

            "assestClass": "Bonds",

            "costPrice": "234.35",

            "weightPercentage": "0.00",

            "costValueSecCcy": "117175",

            "description": "Us Treasury Note 8.05 Pct",

            "marketValue": "731.07",

            "ISIN": "US9128283S79",

            "unrealizedProfitLossSecCcy": "-101153.25",

            "unRealizedPLPercentage": "0.00",

            "holdingsId": "300500-005",

            "secCCy": "USD",

            "unrealPLMkt": "0",

            "isSecurityAsset": true,

            "unrealizedProfitLossPercentageSecCcy": "-86.30",

            "region": "US",

            "sector": "BANK",

            "holdingsType": "OTC1",

            “exchangeRate”:”1.26”

 

        }

    ],

    "opstatus": 0,

    "sortBy": "description",

    "httpStatusCode": 200,

    "status": "success"

}

Wealth FO

Parameters

/portfolioID (Mandatory/)

Specifies the ID field of the customer’s portfolio

/referenceCurrency (Mandatory)

Specifies the customer’s currency

/accountName (Mandatory)

Specifies the portfolio name

/accountNumber (Mandatory)

Specifies the ID field of the customer’s portfolio

/marketValue (Mandatory)

Specifies the total value of the portfolio holdings

/fieldstoDisplay (Mandatory)

Specifies the fields to display

/marketPrice (Mandatory)

Specifies the latest price

/marketValPOS (Mandatory)

Specifies the estimation

/quantity (Mandatory)

Specifies the number of stocks that are bought

/costValue (Mandatory)

Specifies the cost value of the holdings in the reference currency

/assestClass (Mandatory)

Specifies the type of holdings

/costPrice (Mandatory)

Specifies the average cost of the holding

/weightPercentage (Mandatory)

Specifies the weightage of the holdings

/costValueSecCcy (Mandatory)

Specifies the cost value in security currency

/description (Mandatory)

Specifies the name of the instrument

/marketValue (Mandatory)

Specifies the estimated value of the asset

/ISIN (Mandatory)

Specifies the ISIN code of the instrument

/unrealizedProfitLossSecCcy (Mandatory)

Specifies the unrealized profit or loss in security currency

/unRealizedPLPercentage (Mandatory)

Specifies the percentage change in the current profit or loss on any open positions

/holdingsId (Mandatory)

Specifies the instrument ID

/secCCy (Mandatory)

Specifies the instrument currency

/unrealPLMkt (Mandatory)

Specifies the current profit or loss on any open positions

/isSecurityAsset (Mandatory)

Specifies whether the instrument is a securities type of an asset

/region (Mandatory)

Specifies the instrument domicile

/sector (Mandatory)

Specifies the industry

/holdingsType (Mandatory)

Specifies the stock exchange

/exchangeRate (Mandatory)

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

{


    "opstatus_getHoldingsList": 0,

    "fieldstoDisplay": "holdingsId, holdingsType, marketPrice, ISIN, marketValPOS, weightPercentage, unrealPLMkt, region, assestClass, sector, secCCy, marketValue, costValue, unRealizedPLPercentage, quantity, costPrice, description, costValueSecCcy, unrealizedProfitLossSecCcy, unrealizedProfitLossPercentageSecCcy, exchangeRate",

    "portfolioID": "100271-1",

    "referenceCurrency": "CHF",

    "portfolioHoldings": [

        {

            "marketPrice": "525.712",

            "marketValPOS": "788568",

            "referenceCurrency": "CHF",

            "quantity": "1500",

            "costValue": "372639.83",

            "costValueSecCcy": "0.94419994689633",

            "assestClass": "Stock",

            "weightPercentage": "1.17",

            "costPrice": "263.107993333",

            "marketValue": "788568.00",

            "description": "Adobe Sys Inc Comstk(us)",

            "ISIN": "US00724F1012",

            "unrealizedProfitLossSecCcy": "-",

            "unRealizedPLPercentage": "111.62",

            "holdingsId": "100044-000",

            "secCCy": "USD",

            "unrealPLMkt": "415928.17",

            "exchangeRate": "1",

            "isSecurityAsset": true,

            "unrealizedProfitLossPercentageSecCcy": "-",

            "region": "North America",

            "sector": "Other Sectors",

            "holdingsType": "XNYS"

        },

        {

            "marketPrice": "210.859",

            "marketValPOS": "21085.9",

            "referenceCurrency": "CHF",

            "quantity": "100",

            "costValue": "23427.31",

            "costValueSecCcy": "1.1051858652056",

            "assestClass": "Stock",

            "weightPercentage": "0.03",

            "costPrice": "211.9762",

            "marketValue": "21085.90",

            "description": "Allianz Ag (De)",

            "ISIN": "DE0008404005",

            "unrealizedProfitLossSecCcy": "-",

            "unRealizedPLPercentage": "-9.99",

            "holdingsId": "100160-000",

            "secCCy": "EUR",

            "unrealPLMkt": "-2341.41",

            "exchangeRate": "1",

            "isSecurityAsset": true,

            "unrealizedProfitLossPercentageSecCcy": "-",

            "region": "Europe",

            "sector": "Other Sectors",

            "holdingsType": "XEUR"

      

        }

    ],

    "opstatus": 0,

    "sortBy": "description",

    "accountNumber": "100271-1",

    "totalCount": 23,

    "httpStatusCode": 200,

    "status": "success"

}

Error Code(s):

Error Message: Unauthorized Access.

Enterprise Provider:

Transact
Wealth Front Office (FO)

Enterprise API:

Transact: v2.0.0/holdings/portfolios/$portfolioId/holdings

Wealth Front Office (FO):v1.0.0/holdings/portfolios/$portfolioId/positions

Field Mapping

UI field	Experience API Field	Wealth FO API Field	Transact API Field
ISIN (Value only displayed in UI)	ISIN	ISIN_Identifier	ISIN
Average cost	CostValue	CostValCcy	CostValueInReferenceCurrency
	CostValueSecCcy	CostFXRate	CostValue
Market Value	MarketValue	ValueValCcy	AssetEstimation
Region	Region	REGION_CLASS	InstrumentDomicile
Asset Class	AssestClass	Nature	Description
Instrument	Description	Instr_Name	InstrumentName
Exchange Rate	ExchangeRate	FXRate	ExchangeRate
Weight %	WeightPercentage	Weight	Weight
UnRealised P&L	unRealizedPLPercentage	ProfitLossPercent	unRealizedPLPercentageReferenceCurrency
Currency Symbol (Value only displayed in UI)	ReferenceCurrency	Ref_Ccy	ReferenceCurrency
Market Price	MarketPrice	MarketPrice	MarketPrice
UnRealised P&L (Reference ccy)	unRealPLMkt	ProfitLoss	unRealizedPLInReferenceCurrency
	CostPrice	CostPrice	CostPrice
Sector	Sector	Sector	IndustryName
Quantity	Quantity	Quantity	Quantity
Currency Symbol (Value only displayed in UI)	SecCCy	Ccy	Currency
Exchange (Value only displayed in UI)	HoldingsType	ExchangeMarketName	StockExchange
Market Value (PosCcy)	MarketValPOS	ValueValCcy	Estimation
NA	HoldingsID	INSTR_CODE	InstrumentId
UnRealised PL (SecCcy)	unRealizedProfitLossSecCcy		unRealizedProfitLoss
UnRealisedPL % (SecCcy)	unRealizedProfitLossPercentageSecCcy		unRealisedProfitLossPercentage
Portfolio Name (Value only displayed in UI)	AccountName		PortfolioName
NA	AccountNumber	from request PortfolioID	PortfolioID
NA	PortfolioID	from request PortfolioID	PortfolioID
NA	MarketValue	ValueValCcy	TotalAmount

getStockNews

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

getHistoricalData

Description:

This API retrieves the historical data for the specified duration.

Method:

GET

URL:

services/data/v1/WealthOrder/operations/CurrencyDetails/getHistoricalData

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:

Refinitiv

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"

}

Wealth FO

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

getPricingData

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

getDocuments

Description:	This API displays the URL of the available document.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/Documents/getDocuments
Security Level:	Authenticated App User
Header Request:	X-Kony-Authorization X-Kony-ReportingParams
Body Request:	Parameters ISINCode (Mandatory) Specifies the ISIN code of the instrument { "ISINCode": "US0231351067" }
Response:	Parameters /documentDetails (Mandatory) Specifies the JSON array that contains the document details /link (Mandatory) Specifies the URL of the document /mediaType (Mandatory) Specifies the document type /type (Mandatory) Specifies the document type such as Prospectus { "documentDetails": [], "opstatus_getDocuments": 0, "opstatus": 0, "httpStatusCode": "200" }
Error Code(s):	Error Message: Unauthorized Access.
Enterprise Provider:	Refinitiv
Enterprise API:	getDocuments: DocRepository/DocRepository.svc/REST/DocRepository_1/AreDocumentsAvailable_1

Field Mapping

No field mapping for this API.

ViewInstrumentTransactions

Description:

This API retrieves the list of instruments based on the search value.

Method:

GET

URL:

services/data/v1/WealthOrder/operations/InstrumentDetails/viewInstrumentTransactions

Security Level:

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:

Transact

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"

}

Wealth FO

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

createMarketOrder

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

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:

Wealth FO

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

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

modifyOrder

Description:

This API modifies the existing order.

Method:

PUT

URL:

services/data/v1/WealthOrder/operations/Order/modifyOrder

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:

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

cancelOrder

Description:

This API cancels the order that is placed for either buying or selling.

Method:

PUT

URL:

services/data/v1/WealthOrder/operations/Order/cancelOrder

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:

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

getCashAccounts

Description:

This API retrieves the list of cash accounts and their balances.

Method:

POST

URL:

{{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getCashAccounts

Security Level:

AuthenticatQed App User

Header Request:

X-Kony-Authorization
X-Kony-ReportingParam

Body Request:

Parameters

portfolioId (Mandatory)

Specifies the ID of customer’s portfolio

{
    "portfolioId": "100292-1"
}

Response:

Transact

Parameters

/portfolioId (Mandatory)

Specifies the ID of customer’s portfolio

/balance (Mandatory)

Specifies the account balance

/accountName (Mandatory)

Specifies the name of the account

/referenceCurrencyValue (Mandatory)

Specifies the account balance in the reference currency

/currency (Mandatory)

Specifies the currency code of the account’s currency

/accountNumber (Mandatory)

Specifies the unique account number

/totalCashBalanceCurrency (Mandatory)

Specifies the customer’s currency

/totalCashBalance (Mandatory)

Specifies the available cash balance in the customer’s currency

{
    "portfolioID": "100273-1",

    "cashAccounts": [

        {

            "balance": "-1576352.61",

            "currencyName": "United States Dollar",

            "accountName": "DAVID SAINSBURY",

            "referenceCurrencyValue": "-1127899.69",

            "currency": "USD",

            "accountNumber": "100153"

        },

        {

            "balance": "-81073.01",

            "currencyName": "United States Dollar",

            "accountName": "DAVID SAINSBURY",

            "referenceCurrencyValue": "-81073.01",

            "currency": "GBP",

            "accountNumber": "99988"

        },

        {

            "balance": "-53111.26",

            "currencyName": "United States Dollar",

            "accountName": "DAVID SAINSBURY",

            "referenceCurrencyValue": "-45412.1",

            "currency": "EUR",

            "accountNumber": "100188"

        }

    ],

    "opstatus_getCashAccounts": 0,

    "opstatus": 0,

    "totalCashBalanceCurrency": "GBP",

    "totalCashBalance": "-1254384.80",

    "httpStatusCode": "200",

    "status": "success"

}

Wealth FO

Parameters

/portfolioId (Mandatory)

Specifies the ID of customer’s portfolio

/balance (Mandatory)

Specifies the account balance

/accountName (Mandatory)

Specifies the name of the account

/referenceCurrencyValue (Mandatory)

Specifies the account balance in the reference currency

/currency (Mandatory)

Specifies the currency code of the account’s currency

/accountNumber (Mandatory)

Specifies the unique account number

/totalCashBalanceCurrency (Mandatory)

Specifies the customer’s currency

/totalCashBalance (Mandatory)

Specifies the available cash balance in the customer’s currency

{


    "opstatus_getPayInstructions": 0,

    "portfolioID": "100271-1",

    "cashAccounts": [

        {

            "balance": "-50625",

            "accountName": "Swiss Franc",

            "referenceCurrencyValue": "",

            "currency": "CHF",

            "accountNumber": "CHF"

        },

        {

            "balance": "-109660.34",

            "accountName": "100323",

            "referenceCurrencyValue": "",

            "currency": "EUR",

            "accountNumber": "100323"

        },

        {

            "balance": "-8336821.03",

            "accountName": "100145",

            "referenceCurrencyValue": "",

            "currency": "EUR",

            "accountNumber": "100145"

        },

        {

            "balance": "",

            "accountName": "100129",

            "referenceCurrencyValue": "",

            "currency": "EUR",

            "accountNumber": "100129"

        }

    ],

    "opstatus_getCashAccounts": 0,

    "opstatus": 0,

    "totalCashBalanceCurrency": "",

    "totalCashBalance": "",

    "httpStatusCode": 200,

    "status": "success"

}

Error Code(s):

Error Message: Unauthorized Access

Enterprise Provider:

Transact
Wealth Front Office (FO)

Enterprise API:

Transact: v2.0.0/holdings/portfolios/$portfolioId/assetAllocations

Wealth Front Office (FO):

v1.0.0/holdings/portfolios/$portfolioId/position
v1.0.0/order/payInstructions/$portfolioId

Field Mapping

UI field	Experience API Field	Wealth FO API Field	Transact API Field
Account Name (Value only displayed in UI)	AccountName	Instr_Name	AccountName
Balance (Value only displayed in UI)	Balance	Quantity	AmountInAccountCurrency
Balance in RefCurrency (Value only displayed in UI)	ReferenceCurrencyValue		AmountInReferenceCurrency
NA	AccountNumber	Code	AccountId
Currency Symbol (Value only displayed in UI)	Currency	Ccy	AccountCurrency
Total Balance (Value only displayed in UI)	TotalCashBalance		AmountInReferenceCurrency
Currency Symbol (Value only displayed in UI)	TotalCashBalanceCurrency	Ref_Ccy	ReferenceCurrency

getAddCurrency

Description:	This API returns the list of currencies.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/CurrencyDetails/getAddCurrency
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.

getMarketRates

Description:	This API retrieves the market rates for the currency pairs.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/CurrencyDetails/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.

getUserFavouriteInstruments

Description:	This API retrieves the favorite instruments of the user.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/FavouriteInstruments/getUserFavouriteInstruments
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.

updateUserFavouriteInstruments

Description:	This API updates the favorite instruments of the user.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/FavouriteInstruments/updateUserFavouriteInstruments
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.

createOrder

Description:	This API creates a forex order.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/CurrencyDetails/createOrder
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.

getstockNewsDetail

Description:	This API retrieves the stock news for the specified instrument RIC code.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/InstrumentDetails/getstockNewsDetails
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'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'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'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'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 & Friedman (H&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'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

getStockNewsStory

Description:	This API retrieves the stock news story for the instrument story ID.
Method:	GET
URL:	services/data/v1/WealthOrder/operations/InstrumentDetails/getStockNewsStory
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'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'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'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'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 & Friedman (H&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'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

Object Data Models

CurrencyDetails

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.

Documents

Parameter Name	DataType	Description
ISINCode	String	Specifies the portfolio ID of the customers portfolio.

DownloadPDF

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.

FavouriteInstrument

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.

getInstrumentDetails

Parameter Name	DataType	Description
RICCode	String	Specifies the RICCODE of the instrument, which is used to get data from Refinitiv.

getInstrumentMinimal

Parameter Name	DataType	Description
instrumentId	String	Specifies the Instrument Id of the Instrument.

Order

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.

OrderDetails

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.

InstrumentDetails

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.

Portfolio

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.

pricingData

Parameter Name	DataType	Description
RICCode	String	Specifies the RICCode.

productDetails

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.

StockNews

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.

Dark Mode

Expand/Collapse

In this topic