Portfolio Management
| Name | Description | Introduced In |
|---|---|---|
| getDashboardGraphData | This API retrieves the investment details and the chart. | 2021.04 |
| getPortfolioList | This API retrieves the list of the investment portfolios. | 2021.04 |
| getAssetList | This API retrieves the list of assets that grouped by asset class. | 2021.04 |
| getDashboardRecentActivity | This API retrieves the recent activity of the investment accounts. | 2021.04 |
| getDailyMarket | This API retrieves the global indices along with the index value, gain/loss for the day, and the gain % or loss %. | 2021.04 |
| getTopMarketNews | This API retrieves the list of news for the specified topic. | 2021.04 |
| getFavoriteInstruments | This API retrieves the list of favorite instruments | 2021.04 |
| updateUserFavoriteInstruments | This API updates the favorite instruments of the user. | 2021.04 |
| getPortfolioDetails | This API retrieves the portfolio details such as the cash accounts, total value of the portfolio, and the asset details. | 2021.04 |
| getAssetAllocation | This API retrieves the class-wise asset proportion. | 2021.04 |
| getCashAccounts | This API retrieves the list of cash accounts and their balances. | 2021.04 |
| generatePdf | This API generates PDF to download. | 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 |
| getTransactionDetails | This API retrieves the list of transactions of a portfolio. | 2021.04 |
| getAccountActivityOperations | This API retrieves the account activity of the portfolio. | 2021.04 |
| getOrderDetails | This API retrieves the list of orders for the portfolio. | 2021.04 |
| getPortfolioPerformance | This API displays the investment performance. | 2021.04 |
| getFieldsOrder | This API retrieves the order in which the fields must be displayed in Holdings. | 2021.04 |
| updateFieldsOrder | This API update or creates the order of the fields. | 2021.04 |
| getReportAndDownloadTypes | This API retrieves the list of reports to download. | 2021.04 |
| Object Data Models | This Object Data Model describes the parameter name and other attribute details for Portfolio 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
getDashboardGraphData
| Description: | This API retrieves the investment details and the chart. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Dashboard/getDashboardGraphData |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters customerID (Mandatory) Specifies the ID of the customer graphDuration (Mandatory) Specifies the time period {
"customerID":"100777",
"graphDuration":"OneY"
}
|
| Response: |
Parameters /unRealizedPL (Mandatory) Specifies the profit or loss notation /referenceCurrency (Mandatory) Specifies the customer’s reference currency /marketValue (Mandatory) Specifies the total value /graphDuration (Mandatory) Specifies the time period array /AMOUNT (Mandatory) Specifies the total amount /TIMESTAMP (Mandatory) Specifies the date and time value /PERCENTAGE (Mandatory) Specifies the change percentage /PortfolioID (Mandatory) Specifies the ID field of the customer’s portfolio /todayPLAmount (Mandatory) Specifies the profit or loss on an open position comparing the current market price with the previous closing price. /unRealizedPLPercentage (Mandatory) Specifies the percentage change in the current profit or loss on any open positions /unRealizedPLAmount (Mandatory) Specifies the current profit or loss on any open positions /todayPL (Mandatory) Specifies the profit or loss notation. /customerID (Mandatory) Specifies the ID of the customer /todayPLPercentage (Mandatory) Specifies the percentage change of the profit or loss on an open position comparing the current market price with the previous closing price.
{
"unRealizedPL": "P",
"referenceCurrency": "EUR",
"marketValue": "58468986.01",
"graphDuration": [
{
"AMOUNT": "62139036.99",
"TIMESTAMP": "2021-08-18",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "62239036.99",
"TIMESTAMP": "2021-08-31",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "62239036.99",
"TIMESTAMP": "2021-09-08",
"PERCENTAGE": "0.00"
}
],
"todayPLAmount": "",
"unRealizedPLPercentage": "0.00",
"unRealizedPLAmount": "0.00",
"opstatus_getPortfolioList": 0,
"todayPL": "",
"opstatus": 0,
"todayPLPercentage": "",
"opstatus_getDashboardGraphData": 0,
"httpStatusCode": 200,
"status": "success"
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | Wealth Front Office (FO) |
| Enterprise API: | v1.0.0/holdings/customers/$customerID/performance?orderBy=$orderBy&calcFromD=$dateFrom&CalcTilld=$dateTo |
Field Mapping
| UI Field | Experience API Field | Wealth FO API Field |
|---|---|---|
| Currency symbol (Value only displayed in UI) | ReferenceCurrency | REF_CURRENCY |
| Market price (Value only displayed in UI) | Amount | PERIOD_FINAL_MKT_VAL |
| From timestamp for Instrument graph | TimeStamp | PERIOD_INITIAL_DATE |
| To timestamp for Instrument graph | TimeStamp | PERIOD_FINAL_DATE |
| Difference percentage (Value only displayed in UI) | Percentage | DIFF_PERF |
| NA | unRealizedPLAmount | PERIOD_GAIN_LOSS |
getPortfolioList
| Description: | This API retrieves the list of the investment portfolios of the customer. | ||
| Method: | POST | ||
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Dashboard/getPortfolioList | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters customerID (Mandatory) Specifies the ID of the customer {
"customerID":"100271"
}
|
||
| Response: |
Transact
Parameters /customerID (Mandatory) Specifies the ID of the customer /unRealizedPL (Mandatory) Specifies the profit or loss notation /referenceCurrency (Mandatory) Specifies the customer’s currency /accountName (Mandatory) Specifies the name of the portfolio /marketValue (Mandatory) Specifies the total value of the portfolio /unrealizedPLPercentage (Mandatory) Specifies the percentage change in the current profit or loss on any open positions /unrealizedPLAmount (Mandatory) Specifies the current profit or loss on any open positions /portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio /jointHolders (Mandatory) Specifies the joint holder’s name, if any /portfolioNumber (Mandatory) Specifies the ID of the portfolio /investmentType (Mandatory) Specifies the account type /primaryHolder (Mandatory) Specifies the primary account holder’s name /isJointAccount (Mandatory) Specifies whether the account is joint account or not. If this parameter is true, the account is a joint account. /portfolioList (Mandatory) Specifies the JSON array that contains the portfolio list
{
"opstatus": 0,
"PortfolioList": {
"portfolioList": [
{
"unRealizedPL": "P",
"referenceCurrency": "USD",
"accountName": "TestPortfolio",
"marketValue": "999850",
"accountNumber": "200886-1",
"unRealizedPLPercentage": "0.00",
"jointHolders": "",
"unRealizedPLAmount": "0.00",
"portfolioID": "200886-1",
"customerID": "200886",
"investmentType": "Balanced Model",
"jointHolderID": "",
"primaryHolder": "ChrisINFTC0102",
"isJointAccount": "false"
}
]
},
"httpStatusCode": 0
}
Wealth FO
Parameters /customerID (Mandatory) Specifies the ID of the customer /unRealizedPL (Mandatory) Specifies the profit or loss notation /referenceCurrency (Mandatory) Specifies the customer’s currency /accountName (Mandatory) Specifies the name of the portfolio /marketValue (Mandatory) Specifies the total value of the portfolio /unrealizedPLPercentage (Mandatory) Specifies the percentage change in the current profit or loss on any open positions /unrealizedPLAmount (Mandatory) Specifies the current profit or loss on any open positions /portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio /jointHolders (Mandatory) Specifies the joint holder’s name, if any /portfolioNumber (Mandatory) Specifies the ID of the portfolio /investmentType (Mandatory) Specifies the account type /primaryHolder (Mandatory) Specifies the primary account holder’s name /isJointAccount (Mandatory) Specifies whether the account is joint account or not. If this parameter is true, the account is a joint account. /portfolioList (Mandatory) Specifies the JSON array that contains the portfolio list portfolioManagedSince (Mandatory) Specifies the portfolio date portfolioMVCustCurr (Mandatory) Specifies the market value in customer currency {
"opstatus_getPortfolioList": 0,
"isTapIntegration": "true",
"opstatus": 0,
"PortfolioList": {
"portfolioList": [
{
"unRealizedPL": "P",
"referenceCurrency": "CHF",
"portfolioManagedSince": "2003-06-01",
"accountName": "Peugeot Family Portfolio 1",
"marketValue": "6.756377184E7",
"PortfolioMVCustCurr": "6.379372086E7",
"accountNumber": "100271-1",
"unRealizedPLPercentage": "",
"jointHolders": "",
"unRealizedPLAmount": "3.024792297E7",
"portfolioID": "100271-1",
"customerID": "100271",
"investmentType": "",
"jointHolderID": "",
"primaryHolder": "100271",
"isJointAccount": "false"
}
]
},
"httpStatusCode": 200,
"status": "success"
}
|
||
| Error Code(s): | Error Message: Unauthorized Access. | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API Field | Wealth FO API Field | TransactAPI Field |
|---|---|---|---|
| Account name (Value only displayed in UI ) | AccountName | PortfolioName | AccountName |
| NA | PortfolioID | PortfolioCode | PortfolioID |
| NA | CustomerID | ClientCode | CustomerID |
| PrimaryHolder | ClientName | CustomerName | |
| Currency symbol (Value only displayed in UI ) | ReferenceCurrency | PortfolioCCY | ReferenceCurrency |
| NA | JointHolderID | JointCustomer | |
| Joint holders (Value only displayed in UI ) | JointHolders | JointCustomerName | |
| Market price (Value only displayed in UI ) | PortfolioMVCustCurr | PortfolioMVCustCurr | |
| UnrealizedPL (Value only displayed in UI ) | UnRealizedPLAmount | PortfolioPL | |
| NA | PortfolioManagedSince | PortfolioManagedSince | |
| NA | InvestmentType | InvestmentProgram | |
| Market price (Value only displayed in UI ) | MarketValue | PortfolioMV | ValuationAmount |
| NA | AccountNumber | PortfolioCode | PortfolioID |
getAssetList
| Description: | This API retrieves the list of assets grouped by asset class. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Dashboard/getAssetList |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters customerID (Mandatory) Specifies the Customer ID {
"customerID":"100271"
}
|
| Response: |
Parameters /totalAssetValue (Mandatory) Specifies the total value of the assets /AssetList (Mandatory) Specifies the JSON object with asset array and the currency /assets (Mandatory) Specifies the JSON array that contains the asset details. /referenceCurrency (Mandatory) Specifies the customer’s currency /assetGroup (Mandatory) Specifies the class names of the asset /marketValue (Mandatory) Specifies the total value of the respective asset class /customerID (Mandatory) Specifies the ID of the customer {
"opstatus":0,"AssetList":
{
"referenceCurrency":"USD",
"assets":[
{
"assetGroup":"Stocks",
"marketValue":"45155.82"
}
,
{
"assetGroup":"Funds",
"marketValue":"5631.12"
}
,
{
"assetGroup":"Cash",
"marketValue":"30075.06"
}
],"customerID":"100777",
"totalAssetValue":"80862.03",
"opstatus":"0",
"httpStatusCode":"200"
}
,"opstatus_getAssetListMock":0,"httpStatusCode":"200"
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | Wealth Front Office (FO) |
| Enterprise API: | v1.0.0/holdings/customers/$customerID/consolIDatedSummary |
Field Mapping
| UI Field | Experience API Field | Wealth FO API Field |
|---|---|---|
| Currency Symbol (Value only displayed in UI ) | ReferenceCurrency | ValuationCurrency |
| Asset Group (Value only displayed in UI ) | AssetGroup | AssetCode |
| Asset Value (Value only displayed in UI ) | MarketValue | MVAssetClass |
| Total Asset Value (Value only displayed in UI ) | TotalAssetValue | MVAssetClass |
| NA | CustomerID |
getDashboardRecentActivity
| Description: | This API retrieves the recent activity of the customer. | ||
| Method: | POST | ||
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Dashboard/getDashboardRecentActivity | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters customerID (Mandatory) ID of the customer {
"customerID":"100271"
}
|
||
| Response: |
Parameters /orderType (Mandatory) Specifies the transaction type such as buy or sell /quantity (Mandatory) Specifies the trading units /instrumentID (Mandatory) Specifies the instrument ID /description (Mandatory) Specifies the name of the instrument /tradeDate (Mandatory) Specifies the date on which the instrument is bought or sold /marketvalue (Mandatory) Specifies the total value of the portfolio {
"recentActivity": [
{
"orderType": "Buy",
"quantity": "1000",
"instrumentID": "100102-000",
"description": "UK MUTUAL FUND",
"tradeDate": "2021-08-16T00:00:00"
},
{
"orderType": "Buy",
"quantity": "100",
"instrumentID": "100102-000",
"description": "UK MUTUAL FUND",
"tradeDate": "2021-04-15T00:00:00"
}
],
"opstatus_getDashboardRecentActivity": 0,
"opstatus": 0,
"httpStatusCode": 200,
"status": "success"
}
|
||
| Error Code(s): | Error Message: Unauthorized Access | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API Field | Wealth FO API Field | Transact API Field |
|---|---|---|---|
| Purchased/Sold (Value only displayed in UI ) | OrderType | OPERATION_NATURE | TransactionType |
| Quantity (Value only displayed in UI ) | Quantity | QUANTITY | Quantity |
| NA | InstrumentID | INSTR_CODE | Instrument |
| Instrument Name (Value only displayed in UI ) | Description | INSTR_DENOM | InstrumentName |
| Trade Date (Value only displayed in UI ) | TradeDate | OPERATION_DATE | TradeDate |
getDailyMarket
| Description: | This API retrieves the global indices along with the index value, gain/loss for the day, and the gain % or loss %. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/DailyMarket/getDailyMarket |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters None |
| Response: |
Parameters /SimpleDataResult (Mandatory) Specifies the response object /ItemResponse (Mandatory) Specifies an array of ItemResponse /Item (Mandatory) Specifies an array of item /Fields (Mandatory) Specifies the field object /Field (Mandatory) Specfies the JSON array of fields /DataType (Mandatory) Specifies the one of Int8, UInt8, Int16, UInt16, Int32, UInt32, Int64, UInt64, Float, Double, Date, Time, DateTime, Utf8String, RmtesString, AsciiString, and Binary. /Name (Mandatory) Specifies the name of the field /Utf8String / Double / Int32 (Mandatory) This parameter depends on the datatype in the field. {
"GetSimpleData_Response_2": {
"SimpleDataResult": {
"ItemResponse": [
{
"Item": [
{
"Status": {
"StatusMsg": "OK",
"StatusCode": 0
},
"Fields": {
"Field": [
{
"Utf8String": "DJ INDU AVE",
"DataType": "Utf8String",
"Name": "DSPLY_NAME"
},
{
"DataType": "Double",
"Double": 35100,
"Name": "CF_LAST"
},
{
"Utf8String": "DJ INDU AVERG",
"DataType": "Utf8String",
"Name": "CF_NAME"
},
{
"Utf8String": "USD",
"DataType": "Utf8String",
"Name": "CF_CURRENCY"
},
{
"Int32": 0,
"DataType": "Int32",
"Name": "MSG_TYPE"
}
]
}
}
]
}
]
}
},
"opstatus": 0,
"opstatus_getDailyMarket": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | Refinitiv |
| Enterprise API: | QuoteLists/QuoteLists.svc/REST/QuoteLists_1/GetSimpleData_2 |
Field Mapping
| UI Field | Experience API Field | Refinitiv API Field |
|---|---|---|
| Percentage value (Value only displayed in UI ) | Double | Double |
| Instrument name (Value only displayed in UI ) | Name | Name |
| NA | Utf8String | Utf8String |
| NA | DataType | DataType |
| Value (Value only displayed in UI ) | Int32 | Int32 |
getTopMarketNews
| Description: | This API retrieves the list of news for the specified topic. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/MarketNews/getTopMarketNews |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters Topic (Mandatory) Specifies the topic ID {
"Topic":"OLUSBUS"
}
|
| Response: |
Parameters /GetSummaryByTopic_Response_1 (Mandatory) Specifies the response object /StoryMLResponse (Mandatory) Specifies the story ML object /STORYML (Mandatory) Specifies the array of HLs /HL (Mandatory) Specifies the news object /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 {
"GetSummaryByTopic_Response_1": {
"StoryMLResponse": {
"Status": {
"StatusMsg": "OK",
"StatusCode": 0
},
"STORYML": {
"HL": [
{
"ST": "Usable",
"RT": "2021-09-08T06:50:48-00:00",
"PR": "onlinereport.com",
"LN": "en",
"TY": "story",
"LT": "2021-09-08T06:51:44-00:00",
"HT": "German share price index DAX graph is pictured at the stock exchange in Frankfurt",
"space": "preserve",
"CT": "2021-09-08T06:50:48-00:00",
"TE": "<Origin Href=\"StoryRef\">urn:newsml:onlinereport.com:20210908:nRTROPT20210908065048KBN2G40I5</Origin> <Origin Href=\"ThumbnailRef\">2021-09-08T065048Z_1_LYNXMPEH8708S_RTROPTP_1_EUROPE-STOCKS.JPG</Origin> <Origin Href=\"ViewRef\">2021-09-08T065048Z_1_LYNXMPEH8708S_RTROPTP_2_EUROPE-STOCKS.JPG</Origin> <Origin Href=\"BaseRef\">2021-09-08T065048Z_1_LYNXMPEH8708S_RTROPTP_3_EUROPE-STOCKS.JPG</Origin> <Origin Href=\"StoryTitle\">Marketmind: Time to join the green bond gang</Origin> <Origin Href=\"StoryCreationDate\">20210908T065048+0000</Origin> <Origin Href=\"ImageCreationDate\">20210908T065048+0000</Origin> <Origin Href=\"ChannelCode\">OLUSBUS</Origin> <Origin Href=\"LinkTitle\">Reuters US Online Report Business News</Origin>\nFILE PHOTO: The German share price index DAX graph is pictured at the stock exchange in Frankfurt, Germany, September 7, 2021. REUTERS/Staff",
"RE": 1,
"AT": "IDS",
"PE": "7257 99999",
"STORY_PE": "7257 99999",
"TN": 1,
"ID": "urn:newsml:onlinereport.com:20210908:nRTROPT20210908065048LYNXMPEH8708S",
"TO": "OLUSBUS_US BIZ OLUSBUS STX EUROP FINS OLUSBUS_SPO I FIN OLRPIX PICT",
"UR": 4,
"SR": {
"Origin": [
{
"Type": "StoryRef",
"Value": "urn:newsml:onlinereport.com:20210908:nRTROPT20210908065048KBN2G40I5"
},
{
"Type": "ChannelCode",
"Value": "OLUSBUS"
},
{
"Type": "LinkTitle",
"Value": "Reuters US Online Report Business News"
}
]
}
}
]
}
}
},
"opstatus": 0,
"totalCount": 10,
"httpStatusCode": 200,
"opstatus_getTopMarketNews": 0
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | Refinitiv |
| Enterprise API: | OnlineReports/OnlineReports.svc/REST/OnlineReports_1/GetSummaryByTopic_1 |
Field Mapping
| UI Field | Experience API Field | Refinitiv API Field |
|---|---|---|
| NA | HL | HL |
| News Story (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 Headline (Value only displayed in UI) | HT | HT |
getFavoriteInstruments
| Description: | This API retrieves the list of favorite instruments | |||
| Method: | POST | |||
| URL: | {{base_url}}/services/data/v1/WealthOrder/operations/FavouriteInstruments/getFavoriteInstruments | |||
| Security Level: | Authenticated App User | |||
| Header Request: |
|
|||
| Body Request: |
Parameters sortBy (Mandatory) Specifies the field on which the sort needs to be performed pageSize (Optional) Specifies the number of records that are to be returned by the service pageOffset (Optional) Specifies the index of the starting record {
"sortBy": "instrumentName",
"pageSize": "5",
"pageOffset": "0"
}
|
|||
| Response: |
Transact
Parameters /dateTime (Mandatory) Specifies the date and time at which the price was updated /referenceCurrency (Mandatory) Specifies the currency in which the instrument is quoted /ISINCode (Mandatory) Specifies the ISIN code of the instrument /netchange (Mandatory) Specifies the difference between the closing price of a prior trading period and the closing price of the current trading period of an instrument /instrumentID (Mandatory) Specifies the instrument ID /percentageChange (Mandatory) Specifies the net change in terms of percentage /formatDateTime (Mandatory) Specifies the formatted date and time at which the price was updated /bIDRate (Mandatory) Specifies the highest/best price a buyer is willing to pay for an instrument. /RIC (Mandatory) Specifies the RIC code of the instrument /volume (Mandatory) Specifies the number of shares of an instrument traded during a given period of time /instrumentName (Mandatory) Specifies the name of the instrument /lastRate (Mandatory) Specifies the latest price of the instrument /dateReceived (Mandatory) Specifies the date on which the price was updated /timeReceived (Mandatory) Specifies the time at which the price was updated /exchange (Mandatory) Specifies the stock exchange /askRate (Mandatory) Specifies the lowest price at which a person is willing to sell a share
{
"favoriteInstruments": [
{
"dateTime": "2021-04-15T0:00:00",
"referenceCurrency": "USD",
"ISINCode": "US5949181045",
"netchange": "",
"instrumentID": "100012-000",
"percentageChange": "",
"formatDateTime": "15 Apr 2021 at 00:00:00",
"bIDRate": "",
"RIC": "",
"volume": "0",
"instrumentName": "Microsoft Comstk (Us)",
"lastRate": "259.17",
"dateReceived": "15 Apr 2021",
"timeReceived": "0:00:00",
"exchange": "NYSE",
"askRate": ""
}
],
"opstatus": 0,
"totalCount": 3,
"httpStatusCode": "200"
}
Wealth FO
Parameters /dateTime (Mandatory) Specifies the date and time at which the price was updated /referenceCurrency (Mandatory) Specifies the currency in which the instrument is quoted /ISINCode (Mandatory) Specifies the ISIN code of the instrument /netchange (Mandatory) Specifies the difference between the closing price of a prior trading period and the closing price of the current trading period of an instrument /instrumentID (Mandatory) Specifies the instrument ID /percentageChange (Mandatory) Specifies the net change in terms of percentage /formatDateTime (Mandatory) Specifies the formatted date and time at which the price was updated /bIDRate (Mandatory) Specifies the highest/best price a buyer is willing to pay for an instrument. /RIC (Mandatory) Specifies the RIC code of the instrument /volume (Mandatory) Specifies the number of shares of an instrument traded during a given period of time /instrumentName (Mandatory) Specifies the name of the instrument /lastRate (Mandatory) Specifies the latest price of the instrument /dateReceived (Mandatory) Specifies the date on which the price was updated /timeReceived (Mandatory) Specifies the time at which the price was updated /exchange (Mandatory) Specifies the stock exchange /askRate (Mandatory) Specifies the lowest price at which a person is willing to sell a share
{
"favoriteInstruments": [
{
"dateTime": "2021-09-10T20:00:00",
"referenceCurrency": "USD",
"ISINCode": "US0231351067",
"netchange": "0.0",
"instrumentID": "100046-000",
"percentageChange": "0.00",
"formatDateTime": "10 Sep 2021 at 20:00:00",
"bIDRate": "3483.53",
"RIC": "AMZN.O",
"volume": "29072",
"instrumentName": "Amazon.com",
"lastRate": "3469.15",
"dateReceived": "10 SEP 2021",
"timeReceived": "20:00:00",
"exchange": "MKT_NYSE",
"askRate": "3485.20"
}
],
"opstatus": 0,
"totalCount": 3,
"httpStatusCode": "200"
}
|
|||
| Error Code(s): | Error Message: Unauthorized Access | |||
| Enterprise ProvIDer: |
|
|||
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API Field | Wealth FO API Field | Transact API Field | Refinitiv API Field |
|---|---|---|---|---|
| Last Updated (Value only displayed in UI) | DateTime | CF_DATE, CF_TIME | CF_DATE, CF_TIME | |
| Currency Symbol (Value only displayed in UI) | ReferenceCurrency | RefCurrCode | InstrumentCurrencyID | CF_CURRENCY |
| ISIN (Value only displayed in UI) | ISINCode | ExtIsinSynC | ISIN | ISIN_CODE |
| Net Change (Value only displayed in UI) | NetChange | CF_NETCHNG | CF_NETCHNG | |
| NA | InstrumentID | Code | InstrumentID | |
| Percentage Change (Value only displayed in UI) | PercentageChange | PCTCHNG | PCTCHNG | |
| Last Updated (Value only displayed in UI) | FormatDateTime | CF_DATE, CF_TIME | CF_DATE, CF_TIME | |
| BID Rate (Value only displayed in UI) | BIDRate | CF_BID | CF_BID | |
| NA | RIC | Ccode | AlternateInstrumentID | |
| Volume (Value only displayed in UI) | Volume | CF_VOLUME | CF_VOLUME | |
| Instrument Name (Value only displayed in UI) | InstrumentName | Name | InstrumentName | CF_NAME |
| Price (Value only displayed in UI) | LastRate | ExtLastPriceN | LastPrice | CF_LAST |
| NA | DateRecieved | CF_DATE | CF_DATE | |
| NA | TimeRecieved | CF_TIME | CF_TIME | |
| Exchange (Value only displayed in UI) | Exchange | MarketThirdCode | StockExchange | CF_EXCHNG |
| Ask Rate (Value only displayed in UI) | AskRate | CF_ASK | CF_ASK |
updateUserFavouriteInstruments
| Description: | This API updates the favorite instruments of the user. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/WealthOrder/operations/FavouriteInstruments/updateUserFavouriteInstruments |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters RICCode (Mandatory) Specifies the RIC code of the instrument /instrumentID (Mandatory) Specifies the instrument ID operation (Mandatory) Specifies whether to add or delete the instruments from the favorites list {
"RICCode": "AMZN.OQ",
"instrumentID": "100049-000",
"operation": "Add"
}
{
"RICCode": "AMZN.OQ",
"instrumentID": "100049-000",
"operation": "Remove"
}
|
| Response: |
Parameters /favInstrumentCodes (Mandatory) Specifies the RIC code of the instruments listed as favorites /favInstrumentID (Mandatory) Specifies the instrument ID's which are been watchlisted {
"ID": "23",
"favInstrumentCodes": "AMZN.O:AMZN.OQ",
"favInstrumentIDs": "100046-000:100049-000",
"opstatus": 0,
"httpStatusCode": "0"
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | NA |
| Enterprise API: | NA |
Field Mapping
No field mapping for this API.
getPortfolioDetails
| Description: | This API retrieves the portfolio details such as the cash accounts, total value of the portfolio, and the asset details. | ||
| Method: | GET | ||
| URL: | services/data/v1/PortfolioServicing/operations/PortfolioDetails/getPortfolioDetails | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| 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. graphDuration (Mandatory) Specifies the time period {
"portfolioID":"100273-1",
"navPage":"Portfolio",
"graphDuration":"OneM"
}
|
||
| Response: |
Transact
Parameters /referenceCurrency (Mandatory) Specifies the currency of the customer /accountName (Mandatory) Specifies the name of the portfolio /unrealizedPLPercentage (Mandatory) Specifies the percentage change in the current profit or loss on any open positions /currency (Mandatory) Specifies the currency code of the account currency /marketValue (Mandatory) Specifies the total value in the respective asset class /unrealizedPLAmount (Mandatory) Specifies the current profit or loss on any open positions /assetType (Mandatory) This parameter IDentifies the Transact Asset Type Code /assetTypeDesc (Mandatory) Specifies the asset type of the instrument such as Shares, Bonds, and Funds. /valueInReferenceCurrency (Mandatory) This parameter IDentifies to understand the value in reference currency /accountNumber (Mandatory) Specifies the ID of the portfolio /referenceCurrencyValue (Mandatory) Specifies the available amount in the customer currency /portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio /balance (Mandatory) Specifies the account balance /referenceCurrency (Mandatory) Specifies the currency of the customer /assetGroup (Mandatory) Specifies the name of the asset classes /marketValue (Mandatory) Specifies the total value of the portfolio /totalassetValue (Mandatory) Specifies the total value of the assets /portfolioID (Mandatory) Specifies the ID field of customer’s portfolio /amount (Mandatory) Specifies the total amount /timestamp (Mandatory) Specifies the date and time value /percentage (Mandatory) Specifies the change percentage
{
"referenceCurrency": "GBP",
"portfolioID": "100273-1",
"assets": [
{
"assetGroup": "Shares",
"marketValue": "3401542.74"
},
{
"assetGroup": "Bonds",
"marketValue": "29293.47"
},
],
"cashAccounts": [
{
"accountName": "DAVID SAINSBURY",
"referenceCurrencyValue": "-1127899.69",
"graphDuration": "OneM",
"todayPLAmount": "",
"portfolioID": "100273-1",
"balance": "-1576352.61",
"currencyName": "United States Dollar",
"assetTypeDesc": "Bonds",
"todayPL": "",
"currency": "USD",
"todayPLPercentage": "",
"portfolioName": "DavID Sainsbury Portfolio 1",
"unRealizedPL": "P",
"OneM": [],
"referenceCurrency": "GBP",
"marketValue": "1924351.56",
"accountNumber": "100153",
"unRealizedPLPercentage": "91.49",
"assetType": "10",
"valueInReferenceCurrency": "713.27",
"unRealizedPLAmount": "1705655.1109857333",
"portfolioID": "100273-1",
"opstatus": "0",
"httpStatusCode": "200",
"status": "success"
},
{
"unRealizedPL": "P",
"referenceCurrency": "",
"accountName": "DAVID SAINSBURY",
"referenceCurrencyValue": "-81073.01",
"marketValue": "0",
"accountNumber": "99988", "unRealizedPLPercentage": "0.00",
"assetType": "10",
"valueInReferenceCurrency": "6538.11",
"unRealizedPLAmount": "0",
"portfolioID": "",
"balance": "-81073.01",
"currencyName": "United States Dollar",
"assetTypeDesc": "Bonds",
"currency": "GBP",
"portfolioName": ""
}
],
"opstatus_getPortfolioDetails": 0,
"instrumentTotal": [
{
"accountName": "DAVID SAINSBURY",
"referenceCurrencyValue": "-1127899.69",
"graphDuration": "OneM",
"todayPLAmount": "",
"portfolioID": "100273-1",
"balance": "-1576352.61",
"currencyName": "United States Dollar",
"assetTypeDesc": "Bonds",
"todayPL": "",
"currency": "USD",
"todayPLPercentage": "",
"portfolioName": "DavID Sainsbury Portfolio 1",
"unRealizedPL": "P",
"OneM": [],
"referenceCurrency": "GBP",
"marketValue": "1924351.56",
"accountNumber": "100153",
"unRealizedPLPercentage": "91.49",
"assetType": "10",
"valueInReferenceCurrency": "713.27",
"unRealizedPLAmount": "1705655.1109857333",
"portfolioID": "100273-1",
"opstatus": "0",
"httpStatusCode": "200",
"status": "success"
}
],
"totalMarketValue": "3433351.9700000007",
"opstatus": 0,
"totalCashBalanceCurrency": "GBP",
"totalCashBalance": "-1254384.80",
"httpStatusCode": "200",
"status": "success"
}
Wealth FO
Parameters /referenceCurrency (Mandatory) Specifies the currency of the customer /accountName (Mandatory) Specifies the name of the portfolio /unrealizedPLPercentage (Mandatory) Specifies the percentage change in the current profit or loss on any open positions /currency (Mandatory) Specifies the currency code of the account currency /marketValue (Mandatory) Specifies the total value in the respective asset class /unrealizedPLAmount (Mandatory) Specifies the current profit or loss on any open positions /assetType (Mandatory) This parameter IDentifies the Transact Asset Type Code /assetTypeDesc (Mandatory) Specifies the asset type of the instrument such as Shares, Bonds, and Funds. /valueInReferenceCurrency (Mandatory) This parameter IDentifies to understand the value in reference currency /accountNumber (Mandatory) Specifies the ID of the portfolio /referenceCurrencyValue (Mandatory) Specifies the available amount in the customer currency /portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio /balance (Mandatory) Specifies the account balance /referenceCurrency (Mandatory) Specifies the currency of the customer /assetGroup (Mandatory) Specifies the name of the asset classes /marketValue (Mandatory) Specifies the total value of the portfolio /totalassetValue (Mandatory) Specifies the total value of the assets /portfolioID (Mandatory) Specifies the ID field of customer’s portfolio /amount (Mandatory) Specifies the total amount /timestamp (Mandatory) Specifies the date and time value /PERCENTAGE (Mandatory) Specifies the change percentage
{
"opstatus_getPayInstructions": 0,
"referenceCurrency": "CHF",
"cashAccounts": [
{
"balance": "-4285810.72",
"accountName": "Current Account",
"referenceCurrencyValue": "",
"currency": "USD",
"accountNumber": "100161"
},
{
"balance": "",
"accountName": "Current Account",
"referenceCurrencyValue": "",
"currency": "EUR",
"accountNumber": "100129"
},
{
"balance": "",
"accountName": "Gary Ward",
"referenceCurrencyValue": "",
"currency": "GBP",
"accountNumber": "100323"
}
],
"instrumentTotal": [
{
"unRealizedPL": "P",
"referenceCurrency": "CHF",
"accountName": "Peugeot Family Portfolio 1",
"marketValue": "7.038393366E7",
"graphDuration": "OneY",
"todayPLAmount": "",
"accountNumber": "100271-1",
"unRealizedPLPercentage": "33.28",
"unRealizedPLAmount": "1.016584851E7",
"portfolioID": "100271-1",
"todayPL": "",
"OneY": [
{
"AMOUNT": "0",
"TIMESTAMP": "2021-03-16",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "-58584.38",
"TIMESTAMP": "2021-03-31",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "6.986704124E7",
"TIMESTAMP": "2021-04-30",
"PERCENTAGE": "32.30"
},
{
"AMOUNT": "6.986709022E7",
"TIMESTAMP": "2021-05-31",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "6.986699384E7",
"TIMESTAMP": "2021-06-30",
"PERCENTAGE": "-0.00"
},
{
"AMOUNT": "6.986704282E7",
"TIMESTAMP": "2021-07-31",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "6.98670918E7",
"TIMESTAMP": "2021-08-31",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "7.038388152E7",
"TIMESTAMP": "2021-09-30",
"PERCENTAGE": "0.74"
},
{
"AMOUNT": "7.03839305E7",
"TIMESTAMP": "2021-10-31",
"PERCENTAGE": "0.00"
},
{
"AMOUNT": "7.038393366E7",
"TIMESTAMP": "2021-11-02",
"PERCENTAGE": "0.00"
}
],
"todayPLPercentage": ""
}
],
"totalMarketValue": "70383933.66",
"opstatus_getInstrumentTotal": 0,
"totalCashBalanceCurrency": "",
"opstatus_getAssetAllocation": 0,
"portfolioID": "100271-1",
"assets": [
{
"assetGroup": "Stocks",
"marketValue": "7.431975888E7"
},
{
"assetGroup": "LiquIDity",
"marketValue": "-3930088.43"
},
{
"assetGroup": "Derivatives",
"marketValue": "-11315.78"
},
{
"assetGroup": "Fixed Income",
"marketValue": "5578.99"
}
],
"opstatus_getCashAccounts": 0,
"opstatus": 0,
"totalCashBalance": "",
"httpStatusCode": 200,
"status": "success"
}
|
||
| Error Code(s): | Error Message: Unauthorized Access | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API Field | Wealth FO API Field | Transact API Field |
|---|---|---|---|
| Currency Symbol (Value only displayed in UI) | ReferenceCurrency | ValuationCurrency | ReferenceCurrency |
| Portfolio Account Name(Value only displayed in UI) | AccountName | PORTFOLIO_NAME | AccountName |
| PL Percentage (Value only displayed in UI) | unRealizedPLPercentage | DIFF_PERF | unrealisedProfitLossPercentage |
| NA | Currency | AccountCurrency | |
| Market Value (Value only displayed in UI) | MarketValue | PERIOD_FINAL_MKT_VAL | ValuationAmt |
| Unrealized PL (Value only displayed in UI) | unRealizedPLAmount | PERIOD_GAIN_LOSS | unrealProfitLoss |
| NA | AssetType | AssetType | |
| Asset (Value only displayed in UI) | AssetTypeDesc | AssetTypeDescription | |
| ValueInReferenceCurrency | ValueInReferenceCurrency | ||
| NA | AccountNumber | AccountID | |
| Amount in RefCurrency (Value only displayed in UI) | ReferenceCurrencyValue | AmountInReferenceCurrency | |
| NA | PortfolioID | PORTFOLIO_CODE | PortfolioID |
| Balance (Value only displayed in UI) | Balance | AmountInAccountCurrency | |
| Currency Symbol (Value only displayed in UI) | ReferenceCurrency | ValuationCurrency | ValuationCurrency |
| Asset Group (Value only displayed in UI) | AssetGroup | UNIQUE_ASSET_CLASS | AssetTypeDescription |
| Market Value (Value only displayed in UI) | MarketValue | MVAssetClass | ValueInReferenceCurrency |
| Total Asset Value (Value only displayed in UI) | TotalAssetValue | MVAssetClass(Sum) | ValueInReferenceCurrency (Sum) |
| NA | PortfolioID | PortfolioID | |
| Currency Symbol (Value only displayed in UI) | ReferenceCurrency | REF_CURRENCY | |
| Market Price in Portfolio Graph | Amount | PERIOD_FINAL_MKT_VAL | |
| TimeStamp in Portfolio Graph | TimeStamp | PERIOD_INITIAL_DATE | |
| TimeStamp in Portfolio Graph | TimeStamp | PERIOD_FINAL_DATE | |
| Percentage in Portfolio Graph | Percentage | DIFF_PERF | |
| Unrealized PL (Value only displayed in UI) | unRealizedPLAmount | PERIOD_GAIN_LOSS |
getAssetAllocation
| Description: | This API retrieves asset class-wise proportion. | ||
| Method: | POST | ||
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getAssetAllocation | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio {
"portfolioID": "100292-1"
}
|
||
| Response: |
Parameters /referenceCurrency (Mandatory) Specifies the customer’s currency /assets (Mandatory) Specifies the JSON array containing the asset details. /assetGroup (Mandatory) Specifies the class names of the asset /marketValue (Mandatory) Specifies the total value of the respective asset class /totalMarketValue (Mandatory) Specifies the total of the market value of all the asset classes {
"referenceCurrency": "CHF",
"assets": [
{
"assetGroup": "Shares",
"marketValue": "59247666.97"
},
{
"assetGroup": "Bonds",
"marketValue": "31092.45"
},
{
"assetGroup": "Exch Trd Fut",
"marketValue": "-13149.78"
},
{
"assetGroup": "Derivatives",
"marketValue": "6194.34"
},
{
"assetGroup": "Monetary Paper",
"marketValue": "2455.50"
}
],
"totalMarketValue": "5.927425948000001E7",
"opstatus": 0,
"httpStatusCode": "200",
"status": "success",
"opstatus_getAssetAllocation": 0
}
|
||
| Error Code(s): | Error Message: Unauthorized Access. | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| Experience API field | Wealth FO API field | Transact API field |
|---|---|---|
| ReferenceCurrency | ValuationCurrency | ValuationCurrency |
| AssetGroup | UNIQUE_ASSET_CLASS | AssetTypeDescription |
| MarketValue | MVAssetClass | ValueInReferenceCurrency |
| TotalMarketValue | MVAssetClass(Sum) | ValueInReferenceCurrency (Sum) |
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: | Authenticated App User | ||
| Header Request: |
|
||
| 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: |
|
||
| Enterprise API: |
|
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 |
generatePDF
| Description: | This API generates PDF to download. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PortfolioServicing/operations/DownloadPDF/generatePDF |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. sortBy (Optional) Specifies the field on which the sort needs to be performed navPage (Mandatory) This parameter is used to set the field names and retrieve the response from the respected services. /userID (Optional) Specifies the customer ID /fieldOrder (Optional) Specifies the order of the fields pageSize (Optional) Specifies the number of records that are to be returned by the service pageOffset (Optional) Specifies the index of the starting record sortOrder (Optional) Specifies the order used for sorting such as ascending or descending isEuro (Optional) Specifies whether the currency is Euro or not startDate (Optional) Specifies the date from when the records are to be retrieved for the customer endDate (Optional) Specifies the date until when the records are to be retrieved for the customer accountID (Optional) Specifies the account ID of the customer (for account activity report) listType (Optional) Specifies the type of list to be fetched dateFrom (Optional) Specfies the date from when the records are to be retrieved for the customer. dateTo (Optional) Specifies the date until when the records are to be retrieved for the customer. orderID (Optional) Specifies the order reference ID of the order type (Optional) Specifies the type of orders to be fetched duration (Optional) Specifies the time period benchMarkIndex (Optional) Specifies the market indices created by using multiple instruments of the market/sector. currencyID (Optional) Specifies the reference currency of the customer
Holdings :
{"portfolioID":"100273-1","userID":9368711350,"fieldOrder":"0,1,2,3,4,5","navPage":"Holdings","sortBy":"description","pageSize":10,"pageOffset":0,"sortOrder":"ASC","isEuro":"isEuro"}
Transactions :
{"portfolioID":"100273-1","navPage":"Transactions","sortBy":"tradeDate","pageSize":10,"pageOffset":0,"startDate":"2020-02-19","endDate":"2021-08-19","sortOrder":"DESC","isEuro":"isEuro"}
Account Activity:
{"portfolioID":"100273-1","navPage":"Accounts Activity","sortBy":"bookingDate","accountID":11098,"listType":"SEARCH","pageOffset":0,"pageSize":10,"sortOrder":"DESC","dateFrom":20210219,"dateTo":20210819,"isEuro":"isEuro"}
Open Orders :
{"portfolioID":"100285-1","navPage":"Open Order","sortBy":"tradeDate","pageSize":10,"orderID":"","pageOffset":0,"sortOrder":"DESC","type":"Open","startDate":"2021-07-20","endDate":"2021-08-19","isEuro":"isEuro"}
History Orders :
{"portfolioID":"100273-1","navPage":"History Order","sortBy":"tradeDate","pageSize":10,"orderID":"","pageOffset":0,"sortOrder":"DESC","type":"History","startDate":"2021-08-22","endDate":"2021-09-21","isEuro":"isEuro"}
Performance:
{"portfolioID":"100271-1","navPage":"Performance","sortBy":"dateTime","sortOrder":"DESC","pageSize":10,"pageOffset":0,"dateFrom":20200819,"dateTo":20210819,"duration":"OneY","benchMarkIndex":" ","isEuro":"isEuro","currencyID":"CHF"}
|
| Response: |
Parameters /base64 (Mandatory) Specifies the base64 encoded PDF {
"base64": "JVBERi0xLjcKJeLjz9MKNSAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDE5NTY+PnN0cmVhbQp4nKWZW1PcOhLH3+dT6GFqi/OA0F3",
"opstatus": 0,
"httpStatusCode": "200"
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | NA |
| Enterprise API: | NA |
Field Mapping
| UI field | Experience API Field | Wealth FO API Field |
|---|---|---|
| Base64 |
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: |
|
||
| 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: |
|
||
| Enterprise API: |
|
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 |
getTransactionDetails
| Description: | This API retrieves the list of transactions of a portfolio. | ||
| Method: | POST | ||
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getTransactionDetails | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio 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 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 isEuro (Optional) Specifies whether the currency is Euro or not pageSize (Optional) Specifies the number of records that are to be returned pageOffset (Optional) Specifies the index of the starting record navPage (Mandatory) This parameter is used to download the field names. {
"portfolioID": "100285-1",
"userID": 7312057965,
"fieldOrder": "fieldOrder",
"navPage": "Holdings",
"sortBy": "description",
"pageSize": 10,
"pageOffset": 0,
"sortOrder": "ASC",
"isEuro": "isEuro",
"startDate": "2019-01-01",
"endDate": "2021-09-09"
}
|
||
| Response: |
Transact
Parameters /orderType Mandatory) Specifies the order type such as Market, Limit, and Stop Loss /fees (Mandatory) Specifies the total fees for the transaction /quantity (Mandatory) Specifies the quantity that is either bought or sold /referenceCurrency (Mandatory) Specifies the customer’s currency /limitPrice Specifies the price at which the stocks are to be sold or bought. /description (Mandatory) Specifies the name of the Instrument /instrumentAmount (Mandatory) Specifies the product of the quantity and the limit price /tradeDate (Mandatory) Specifies the 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 in which the transaction occurs /transactionID (Mandatory) Specifies the unique ID for the transaction /total (Mandatory) Specifies the instrument amount that includes the fees /exchangeRate (Mandatory) Specifies the exchange rate if it’s a cross-currency /instrumentCurrency (Mandatory) Specifies the currency of the instrument /customerID (Mandatory) Specifies the customer’s ID /holdingsType (Mandatory) Specifies the stock exchange netAmount (Optional) Specifies the amount value /instrumentID (Mandatory) Specifies the instrument ID
{
"opstatus_getTransactionDetails": 0,
"portfolioTransactions": [
{
"orderType": "SECURITY PURCHASE",
"fees": "928.09",
"quantity": "2,000",
"referenceCurrency": "CHF",
"limitPrice": "84.7225",
"netAmount": "169445",
"instrumentID": "100071-000",
"description": "Dell Computer Corp Comstk(us)",
"instrumentAmount": "155533.57",
"tradeDate": "2021-04-08",
"valueDate": "2021-04-08",
"ISIN": "US24702R1014",
"tradeCurrency": "USD",
"transactionID": "SCTRSC210982XQF3",
"total": "156461.66",
"exchangeRate": "0.917900000",
"instrumentCurrency": "USD",
"customerID": "100271",
"holdingsType": "NYSE"
},
{
"orderType": "SECURITY PURCHASE",
"fees": "-640.42",
"quantity": "200",
"referenceCurrency": "CHF",
"limitPrice": "209.599",
"netAmount": "41919.8",
"instrumentID": "100160-000",
"description": "Allianz Ag (De)",
"instrumentAmount": "45031.02",
"tradeDate": "2021-04-08",
"valueDate": "2021-04-08",
"ISIN": "DE0008404005",
"tradeCurrency": "EUR",
"transactionID": "SCTRSC210988RS1D",
"total": "44390.6",
"exchangeRate": "1.074218370",
"instrumentCurrency": "EUR",
"customerID": "100271",
"holdingsType": "FFT"
}
],
"endDate": "2021-08-31",
"pageSize": 10,
"totalCount": 45,
"searchByInstrumentName": "",
"portfolioID": "100271-1",
"sortOrder": "DESC",
"pageOffset": 0,
"opstatus": 0,
"sortBy": "tradeDate",
"startDate": "2019-08-01",
"httpStatusCode": 200,
"status": "success"
}
Wealth FO
Parameters /orderType Mandatory) Specifies the order type such as Market, Limit, and Stop Loss /fees (Mandatory) Specifies the total fees for the transaction /quantity (Mandatory) Specifies the quantity that is either bought or sold /referenceCurrency (Mandatory) Specifies the customer’s currency /limitPrice Specifies the price at which the stocks are to be sold or bought. /description (Mandatory) Specifies the name of the Instrument /instrumentAmount (Mandatory) Specifies the product of the quantity and the limit price /tradeDate (Mandatory) Specifies the 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 in which the transaction occurs /transactionID (Mandatory) Specifies the unique ID for the transaction /total (Mandatory) Specifies the instrument amount that includes the fees /exchangeRate (Mandatory) Specifies the exchange rate if it’s a cross-currency /instrumentCurrency (Mandatory) Specifies the currency of the instrument /customerID (Mandatory) Specifies the customer’s ID /holdingsType (Mandatory) Specifies the stock exchange netAmount (Optional) Specifies the amount value /instrumentID (Mandatory) Specifies the instrument ID
{
"opstatus_getTransactionDetails": 0,
"portfolioTransactions": [
{
"orderType": "Buy",
"fees": "0.0",
"quantity": "500",
"referenceCurrency": "CHF",
"limitPrice": "101.25",
"netAmount": "50625",
"instrumentID": "100101-000",
"description": "Scb Mutual Fund",
"instrumentAmount": "50625",
"tradeDate": "2021-07-14T00:00:00",
"valueDate": "2021-07-15T00:00:00",
"tradeCurrency": "CHF",
"ISIN": "CH1234567",
"transactionID": "D1002711036",
"total": "50625",
"exchangeRate": "1",
"customerID": "1241",
"instrumentCurrency": "CHF",
"holdingsType": "XSWX"
},
{
"orderType": "Sell",
"fees": "855.89",
"quantity": "100",
"referenceCurrency": "CHF",
"limitPrice": "3434.3275",
"netAmount": "343432.75",
"instrumentID": "100046-000",
"description": "Amazon.com",
"instrumentAmount": "324269.2",
"tradeDate": "2021-04-15T00:00:00",
"valueDate": "2021-07-28T00:00:00",
"tradeCurrency": "USD",
"ISIN": "US0231351067",
"transactionID": "202104159999963051.00_SCTRSC211058GNQJ_BNK",
"total": "323461.07",
"exchangeRate": "0.94419999257497",
"customerID": "1241",
"instrumentCurrency": "USD",
"holdingsType": "XNYS"
}
],
"referenceCurrency": "CHF",
"endDate": "2021-08-31",
"pageSize": 10,
"totalCount": 123,
"searchByInstrumentName": "",
"portfolioID": "100271-1",
"sortOrder": "",
"pageOffset": 0,
"opstatus": 0,
"sortBy": "",
"startDate": "2019-08-01",
"httpStatusCode": 200,
"status": "success"
}
|
||
| Error Code(s): | Error Message: Unauthorized Access. | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API field | Wealth FO API Field | Transact API Field |
|---|---|---|---|
| Type | OrderType | OPERATION_NATURE | TransactionName |
| Fees | 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 | FeesAndTaxesInReferenceCurrency |
| Quantity. | Quantity | QUANTITY | Quantity |
| Currency Symbol (Value only displayed in UI) | ReferenceCurrency | REF_CCY | ReferenceCurrency |
| Price | LimitPrice | PRICE | Price |
| Amount | NetAmount | GROSS_AMOUNT_OPER_CURR | GrossAmount |
| NA | InstrumentID | INSTR_CODE | Instrument |
| Instrument | Description | INSTR_NAME | InstrumentName |
| Amount (Instr) | InstrumentAmount | Gross_Amount_Instr_CCY | ValueInReferenceCurrency |
| Trade date | TradeDate | OPERATION_DATE | TradeDate |
| Value date | ValueDate | VALUE_DATE | ValueDate |
| Currency (Value only displayed in UI) | TradeCurrency | POS_CCY | TradeCurrency |
| ISIN (Value only displayed in UI) | ISIN | ISIN_IDentifier | ISIN |
| NA | TransactionID | OPERATION_CODE | TransactionID |
| Total | Total | NET_AMOUNT_REF_CURR | AmountInReferenceCurrency |
| Exchange rate | ExchangeRate | EXCH_RATE | ExchangeRate |
| NA | CustomerID | Client_ID | Customer |
| Currency symbol (Value only displayed in UI) | InstrumentCurrency | INSTR_CCY | InstrumentCurrencyID |
| Exchange (Value only displayed in UI) | HoldingsType | ExchangeMarketName | StockExchange |
getAccountActivityOperations
| Description: | This API retrieves the account activity of the portfolio. | ||
| Method: | POST | ||
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/AccountActivity/getAccountActivityOperations | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio dateFrom (Mandatory) Specifies the date from when the records are to be retrieved for the customer dateTo (Mandatory) Specifies the date until when the records are to be retrieved for the customer sortBy (Mandatory) Specifies the field on which the sort needs to be performed isEuro (Optional) Specifies whether the currency is Euro or not sortOrder (Optional) Specifies the order used for sorting such as ascending or descending pageSize (Optional) Specifies the number of records to be returned pageOffset (Optional) Specifies the index of the starting record navPage (Mandatory) This parameter is used for downloads to get the field names. listType (Mandatory) Specifies the type of list to be fetched accountID (Mandatory) Specifies the account ID of the customer {
"portfolioID": "100271-1",
"navPage": "Accounts Activity",
"sortBy": "amount",
"accountID": 14389,
"listType": "SEARCH",
"pageOffset": 0,
"pageSize": 10,
"sortOrder": "DESC",
"dateFrom": 20210219,
"dateTo": 20210819,
"isEuro": "isEuro"
}
|
||
| Response: |
Transact
Parameters /accountID (Mandatory) Specifies the account ID of the customer /amount (Mandatory) Specifies the amount that is debited or credited during the transaction /quantity (Mandatory) Specifies the total number of stocks that are bought or sold /balance (Mandatory) Specifies the account balance consIDering the current movement /transactionReference (Mandatory) Specifies the unique ID of the transaction /displayName (Mandatory) Specifies the type of account activity /bookingDate (Mandatory) Specifies the date on which the account movement is booked /valueDate (Mandatory) Specifies the value date of the transaction /currencyID (Mandatory) Specifies the currency code of the activity /shortName (Mandatory) Specifies the name of the instrument /ISIN (Mandatory) Specifies the ISIN code of the Instrument /holdingsType (Mandatory) Specifes the stock exchange of the holding
{
"accountActivityList": {
"header": {
"status": "success"
},
"body": [
{
"accountID": "14389",
"amount": "-125329.78",
"quantity": "800 200",
"balance": "-125329.78",
"transactionReference": "SCTRSC21078RYBVB",
"displayName": "Securities Purchase",
"bookingDate": "20210319",
"valueDate": "20210319",
"shortName": "Macy Inc",
"currencyID": "EUR",
"ISIN": "US55616P1049",
"holdingsType": "NYSE"
}
]
},
"opstatus": 0,
"totalCount": 18,
"httpStatusCode": 0
}
Wealth FO
Parameters /accountID (Mandatory) Specifies the account ID of the customer /amount (Mandatory) Specifies the amount that is debited or credited during the transaction /quantity (Mandatory) Specifies the total number of stocks that are bought or sold /balance (Mandatory) Specifies the account balance consIDering the current movement /transactionReference (Mandatory) Specifies the unique ID of the transaction /displayName (Mandatory) Specifies the type of account activity /bookingDate (Mandatory) Specifies the date on which the account movement is booked /valueDate (Mandatory) Specifies the value date of the transaction /currencyID (Mandatory) Specifies the currency code of the activity /shortName (Mandatory) Specifies the name of the instrument /ISIN (Mandatory) Specifies the ISIN code of the Instrument /holdingsType (Mandatory) Specifes the stock exchange of the holding
{
"accountActivityList": {
"header": {
"status": "success"
},
"body": [
{
"amount": "10135",
"quantity": "100",
"transactionReference": "",
"displayName": "Sell",
"valueDate": "20210728",
"ISIN": "US1234567",
"accountID": "100323",
"portfolioID": "1",
"balance": "-16545.34",
"bookingDate": "20210415",
"currencyID": "EUR",
"shortName": "Uk Mutual Fund",
"holdingsType": "XLON"
}
]
},
"opstatus": 0,
"totalCount": 37,
"httpStatusCode": 0
}
|
||
| Error Code(s): | Error Message: Unauthorized Access. | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| UI field | Experience API field | Wealth FO API field | Transact API field |
|---|---|---|---|
| Amount | Amount | DEBIT_CREDIT | Amount |
| Quantity | Quantity | QUANTITY | Quantity |
| NA | AccountID | ACCOUNT_CODE | AccountID |
| NA | Balance | ACCOUNT_BALANCE | Balance |
| NA | TransactionReference | TransactionReference | |
| Instrument | DisplayName | OPERATION_NATURE | DisplayName |
| NA | BookingDate | OPERATION_DATE | BookingDate |
| Value Date | ValueDate | VALUE_DATE | ValueDate |
| Instrument | ShortName | Instr_Name | ShortName |
| Currency Symbol (Value only displayed in UI) | CurrencyID | POS_CURRENCY | CurrencyID |
| ISIN (Value only displayed in UI) | ISIN | ISIN_IDentifier | ISIN |
| Exchange (Value only displayed in UI) | HoldingsType | ExchangeMarketNam | StockExchange |
getOrderDetails
| Description: | This API retrieves the list of orders for the portfolio | ||
| Method: | POST | ||
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getOrdersDetails | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
|
||
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the portfolio sortBy (Mandatory) Specifies the field on which the sort needs to be performed navPage (Mandatory) This parameter is used for downloads to get the field names. pageSize (Optional) Specifies the number of records to be returned pageOffset (Optional) Specifies the index of the starting record sortOrder (Optional) Specifies the order used for sorting such as ascending or descending isEuro (Optional) Specifies whether the currency is Euro or not 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 orderID (Mandatory) Specifies the unique order reference ID type (Mandatory) Specifies the order type such as open or history searchByInstrumentName (Mandatory) Specifies the value on which the search needs to be performed Open Order:
{
"portfolioID": "100271-1",
"navPage": "Open Order",
"sortBy": "tradeDate",
"pageSize": 10,
"orderID": "",
"pageOffset": 0,
"sortOrder": "DESC",
"type": "Open",
"isEuro": "isEuro"
}
History Order:
{
"portfolioID": "100292-1",
"navPage": "History Order",
"sortBy": "tradeDate",
"searchByInstrumentName": "Ama",
"pageSize": 10,
"orderID": "",
"pageOffset": 0,
"sortOrder": "DESC",
"type": "History",
"startDate": "2021-03-03",
"endDate": "2021-08-31",
"isEuro": "isEuro"
}
|
||
| Response: |
Transact
Parameters /orderType(Mandatory) Specifies the type and transaction of the order /quantity(Mandatory) Specifies the number of stocks to be bought/sold /limitPrice(Mandatory) Specifies the price at which the stocks are to be sold or bought. /instrumentID(Mandatory) Specifies the ID of the transaction instrument /description(Mandatory) Specifies the name of the instrument /tradeDate(Mandatory) Specifies the date of the transaction /ISIN(Mandatory) Specifies the ISIN Code for the instrument /assetType (Mandatory) This parameter IDentifies the Transact Asset Type Code /orderedAt(Mandatory) Specifies the time of the order creation /stopPrice(Mandatory) Specifies the price at which an order is triggered and converted into a market or a limit order /orderMode(Mandatory) Specifies the transaction type such as Buy or FPR /orderModeType(Mandatory) Specifies the order type such as Market and Limit /isModifyEnable(Mandatory) Specifies whether modify option is applicable or not /isCancelEnable(Mandatory) Specifies whether cancel option is applicable or not /instrumentCurrency(Mandatory) Specifies the currency of the instrument /orderReference(Mandatory) Specifies the order reference ID /valIDity(Mandatory) Specifies the time-period for which the order placed is valID /holdingsType(Mandatory) Specifies the stock exchange /orderExecutionPrice(Mandatory) Specifies the price at which an order gets executed in the market /status(Mandatory) Specifies the status of the order such as open or completed
{
"ordersDetails": [
{
"orderType": "Buy Market",
"quantity": "2000",
"limitPrice": "",
"instrumentID": "100046-000",
"description": "Amazon.com",
"tradeDate": "2021-04-15",
"ISIN": "US0231351067",
"orderedAt": "23:23:52",
"stopPrice": "",
"orderMode": "Buy",
"orderModeType": "Market",
"instrumentCurrency": "USD",
"orderReference": "OPODSC2110571719",
"valIDity": "Day Order",
"holdingsType": "NYSE",
"orderExecutionPrice": "",
"status": "Open",
“transactionName”:”SECURITY PURCHASE”
}
],
"portfolioID": "100271-1",
"opstatus_getOrderDetails": 0,
"endDate": "",
"sortOrder": "DESC",
"opstatus": 0,
"sortBy": "tradeDate",
"totalCount": 6,
"startDate": "",
"httpStatusCode": "200",
"status": "success"
}
Wealth FO
Parameters /orderType(Mandatory) Specifies the type and transaction of the order /quantity(Mandatory) Specifies the number of stocks to be bought/sold /limitPrice(Mandatory) Specifies the price at which the stocks are to be sold or bought. /instrumentID(Mandatory) Specifies the ID of the transaction instrument /description(Mandatory) Specifies the name of the instrument /tradeDate(Mandatory) Specifies the date of the transaction /ISIN(Mandatory) Specifies the ISIN Code for the instrument /assetType (Mandatory) This parameter IDentifies the Transact Asset Type Code /orderedAt(Mandatory) Specifies the time of the order creation /stopPrice(Mandatory) Specifies the price at which an order is triggered and converted into a market or a limit order /orderMode(Mandatory) Specifies the transaction type such as Buy or FPR /orderModeType(Mandatory) Specifies the order type such as Market and Limit /isModifyEnable(Mandatory) Specifies whether modify option is applicable or not /isCancelEnable(Mandatory) Specifies whether cancel option is applicable or not /instrumentCurrency(Mandatory) Specifies the currency of the instrument /orderReference(Mandatory) Specifies the order reference ID /valIDity(Mandatory) Specifies the time-period for which the order placed is valID /holdingsType(Mandatory) Specifies the stock exchange /orderExecutionPrice(Mandatory) Specifies the price at which an order gets executed in the market /status(Mandatory) Specifies the status of the order such as open or completed
{
"orderType": "Buy Market",
"quantity": "100",
"limitPrice": "",
"isTapIntegration": "true",
"instrumentID": "100046-000",
"description": "Amazon.com",
"tradeDate": "2021-09-08",
"ISIN": "US0231351067",
"assetType": "Stock",
"orderedAt": "08/09/2021 19:52:12",
"stopPrice": "",
"orderMode": "Buy",
"orderModeType": "Market",
"isModifyEnable": "true",
"isCancelEnable": "true",
"instrumentCurrency": "USD",
"orderReference": "D1002711492",
"valIDity": "Day Order",
"holdingsType": "NEW YORK",
"uniqueID": 0,
"orderExecutionPrice": "",
"status": "Open"
}
],
"portfolioID": "100271-1",
"sortOrder": "DESC",
"globalorderIDs": "",
"opstatus": 0,
"sortBy": "tradeDate",
"globalpartialcompleted_index": "",
"startDate": "",
"httpStatusCode": "200",
"status": "success"
}
|
||
| Error Code(s): | Error Message: Unauthorized Access. | ||
| Enterprise ProvIDer: |
|
||
| Enterprise API: |
|
Field Mapping
| UI field | Experience API Field | Wealth FO API Field | Transact API Field |
|---|---|---|---|
| Type | Order Type | Order_Nature, Limit_Nature | TransactionType, OrderType |
| Quantity | Quantity | QUANTITY | Quantity |
| Limit Price | Limit Price | LIMIT | LimitPrice |
| NA | InstrumentID | INSTR_CODE | InstrumentID |
| Instrument | Description | INSTR_NAME | InstrumentName |
| NA | TradeDate | ORDER_ENTRY_DATE | OrderDate |
| ISIN (Value only displayed in UI) | ISIN | ISIN_IDentifier | ISIN |
| NA | AssetType | INSTR_NATURE | |
| Date | OrderedAt | ORDER_ENTRY_DATETIME_TZ | OrderedAt |
| Price | StopPrice | STOP | Price |
| Price | OrderMode | ORDER_NATURE | TransactionType |
| Type | OrderModeType | LIMIT_NATURE | OrderType |
| NA | IsModifyEnable | ActionRightUpdate | |
| NA | IsCancelEnable | ACTION_RIGHT_CANCEL | |
| InstrumentCurrency | ORDER_CURRENCY | InstrumentCurrencyID | |
| Reference ID | OrderReference | ORDER_CODE | TransactionReference |
| NA | ValIDity | orderValIDityNature | LimitType |
| Exchange (Value only displayed in UI) | HoldingsType | MARKET | StockExchange |
| Price | OrderExecutionPrice | STOP/ LIMIT | LimitPrice/Price |
| Status | Status | STATUS | OrderStatus |
| NA | TransactionName | TransactionName |
getPortfolioPerformance
| Description: | This API displays the investment performance. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioPerformance/getPortfolioPerformance |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio sortBy (Optional) Specifies the field on which the sort needs to be performed navPage (Mandatory) This parameter is used for downloads to get the field names. dateFrom (Mandatory) Specifies the date from when the records are to be retrieved for the customer dateTo (Mandatory) Specifies the date until when the records are to be retrieved for the customer pageSize (Optional) Specifies the number of records to be returned pageOffset (Optional) Specifies the index of the starting record sortOrder (Optional) Specifies the order used for sorting such as ascending or descending isEuro (Optional) Specifies whether the currency is Euro or not duration (Mandatory) Specifies the time period benchMarkIndex (Mandatory) Specifies the market indices that are created by using multiple instruments of the market or sector currencyID (Optional) Specifies the reference currency of the customer {
"portfolioID": "100271-1",
"navPage": "Performance",
"sortBy": "dateTime",
"sortOrder": "DESC",
"pageSize": 10,
"pageOffset": 0,
"dateFrom": 20200819,
"dateTo": 20210819,
"duration": "OneY",
"benchMarkIndex": " ",
"isEuro": "isEuro",
"currencyID": "USD"
}
|
| Response: |
Parameters /benchMarkID (Mandatory) Specifies the unique ID for benchmark /benchMark (Mandatory) Specifies the market indices that are created by using multiple instruments of the market or sector /dateTime (Mandatory) Specifies the date and time on which the value was recorded /portfolioReturn (Mandatory) Specifies the portfolio value as on the date /benchMarkIndex (Mandatory) Specifies the benchmark return as of on the current date /percentageChange (Mandatory) Specifies the portfolio return as of on the current date /timeWeighted (Mandatory) The time-weighted rate of return is a measure of the compound rate of growth in a portfolio. /netDeposit (Mandatory) Specifies the net deposit value of the portfolio /moneyWeighted (Mandatory) The Money-weighted rate of return is a measure of the performance of an investment. /pl (Mandatory) Specifies the profit and loss for the selected time period /initialValue (Mandatory) Specifies the initial value of the portfolio for the selected time period /currentValue (Mandatory) Specifies the current value of the portfolio for the selected time period /feesAndTax (Mandatory) Specifies the total amount of fees and taxes collected in the portfolio /selectedBenchMark (Optional) Specifies the selected benchmark
{
"referenceCurrency": "USD",
"benchMarkList": [
{
"benchMarkID": "2001",
"benchMark": "BM_MP1"
}
],
"pageSize": "10",
"sortedMonthlyOverview": [
{
"dateTime": "20210913",
"portfolioReturn": "1.11790180652E9",
"benchMarkIndex": "0.00",
"percentageChange": "-0.21"
},
{
"dateTime": "20210831",
"portfolioReturn": "1.11790180652E9",
"benchMarkIndex": "0.00",
"percentageChange": "-0.21"
}
],
"totalCount": 6,
"performanceList": {
"timeWeighted": "-0.2139774",
"netDeposit": "1.12029899288E9",
"moneyWeighted": "",
"pl": "-2397186.36",
"initialValue": "0",
"currentValue": "1.11790180652E9",
"feesAndTax": "0"
},
"portfolioID": "100285-1",
"monthlyOverview": [
{
"dateTime": "20210831",
"portfolioReturn": "1.11790180652E9",
"benchMarkIndex": "0.00",
"percentageChange": "-0.21"
},
{
"dateTime": "20210913",
"portfolioReturn": "1.11790180652E9",
"benchMarkIndex": "0.00",
"percentageChange": "-0.21"
}
],
"sortOrder": "DESC",
"pageOffset": "0",
"opstatus": 0,
"sortBy": "dateTime",
"selectedBenchMark": "BM_MP1",
"httpStatusCode": 200,
"status": "success"
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | Wealth Front Office (FO) |
| Enterprise API: | Wealth FO:
|
Field Mapping
| UI field | Experience API field | Wealth FO API field |
|---|---|---|
| NA | BenchMarkID | ID |
| NA | BenchMark | StrategyCode |
| Date | DateTime | PERIOD_INITIAL_DATE, PERIOD_FINAL_DATE |
| Portfolio Rreturn | PortfolioReturn | PERIOD_FINAL_MKT_VAL |
| NA | BenchMarkIndex | BENCH_PERFORMANCE |
| Percentage Change in Performance Graph | PercentageChange | PTF_PERF_CUMUL |
| Time-Weighted Return | TimeWeighted | PERIOD_RET_TWR |
| Net Deposit | NetDeposit | PERIOD_INVEST_WITHDRAWAL |
| Money-Weighted Return | MoneyWeighted | |
| P&L | PL | PERIOD_GAIN_LOSS |
| Initial Value | InitialValue | PERIOD_INITIAL_MKT_VAL |
| Current Value | CurrentValue | PERIOD_FINAL_MKT_VAL |
| Fees & Taxes | FeesAndTax | PERIOD_FEE_TAX |
| Benchmark (Value only displayed in UI) | SelectedBenchMark | StrategyCode |
getFieldsOrder
| Description: | This API retrieves the order in which the fields need to be displayed in Holdings. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getFieldsOrder |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters portfolioID (Mandatory) ID of customer’s portfolio sortBy (Optional) Specifies the field on which the sort needs to be performed navPage (Mandatory) This parameter is used for downloads to get the field names. userID (Mandatory) Specifies the Customer ID /fieldOrder (Mandatory) Specifies the order of the fields pageSize (Optional) Specifies the number of records to be returned pageOffset (Optional) Specifies the index of the starting record sortOrder (Optional) Specifies the order used for sorting such as ascending or descending isEuro (Optional) Specifies whether the currency is Euro or not {
"portfolioID": "100285-1",
"userID": 1,
"fieldOrder": "fieldOrder",
"navPage": "Holdings",
"sortBy": "description",
"pageSize": 10,
"pageOffset": 0,
"sortOrder": "ASC",
"isEuro": "isEuro"
}
|
| Response: |
Parameters /lastmodifiedts (Mandatory) Specifes the last modified date /portfolioID (Mandatory) Specifies the ID of the customer’s portfolio /fieldOrder (Mandatory) Specifies the order of the fields /ID (Mandatory) Specifies the unique ID of the preference /synctimestamp (Mandatory) Specifies the synced timestamp /createdts (Mandatory) Specifies the created date /userID (Mandatory) Specifies the customer ID /softdeleteflag (Mandatory) Specifies the soft delete flag {
"opstatus": 0,
"wealthuserpreferences": [
{
"lastmodifiedts": "2021-08-31 09:39:06.0",
"portfolioID": "100285-1",
"fieldOrder": "1,12,4,8,2,3,7,6,5,9,10,13,14,15,17,16",
"ID": "1153911170",
"synctimestamp": "2021-08-31 09:39:06.0",
"createdts": "2021-08-31 09:39:06.0",
"userID": "1",
"softdeleteflag": "false"
}
],
"httpStatusCode": 0
}
|
| Error Code(s): | Error Message: Unauthorized Access. |
| Enterprise ProvIDer: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI field | Experience API field | Wealth FO API field |
|---|---|---|
| LastModifiedTS | ||
| PortfolioID | ||
| FieldOrder | ||
| ID | ||
| SyncTimeStamp | ||
| CreatedTS | ||
| UserID | ||
| SoftdeeteFlag |
updateFieldsOrder
| Description: | This API update or creates the order of the fields. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/updateFieldsOrder |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio userID (Mandatory) Specifies the customer ID fieldOrder (Mandatory) Specifies the order of the fields {
"portfolioID":"100285-1",
"userID":"1",
"fieldOrder":"1,12,4,8,2,3,7,6,5,9,10,13,14,15,17,16"
}
|
| Response: |
Parameters /msg (Mandatory) Specifies the success message for creation and update {
"msg": "User preferences updated successfully",
"opstatus": 0,
"status": "Success",
"httpStatusCode": "200"
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI field | Experience API field | Wealth FO API field |
|---|---|---|
| msg |
getReportAndDownloadTypes
| Description: | This API retrieves the list of reports to download. |
| Method: | POST |
| URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Reports/getReportAndDownloadTypes |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters navPage (Mandatory) This parameter retrieves the fields and response for the mentioned report portfolioID (Mandatory) Specifies the ID of the customer’s portfolio {
"portfolioID": "100285-1",
"navPage": "Reports"
}
|
| Response: |
Parameters /downloadType (Mandatory) Specifies the name of the report /reportType (Mandatory) Specifies the name of the report /languageDescription (Mandatory) Specifies the name of the language /languageCode (Mandatory) Specifies the code of the language /searchByInstrumentName (Mandatory) Specifies the value on which the search needs to be performed /portfolioID (Mandatory) Specifies the ID of the customer’s portfolio /navPage (Mandatory) This parameter is used to set the field names and retrieves the response from the respective services. /dateTo (Mandatory) Specifies the date until when the records are to be retrieved for the customer /dateFrom (Mandatory) Specifies the date from when the records are to be retrieved for the customer /currencyID (Mandatory) Specifies the reference currency of the customer /listType (Mandatory) Specifies the type of the list to be fetched /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 /type (Mandatory) Specifies the type of orders to be fetched /sortBy (Mandatory) Specifies the field on which the sort needs to be performed /accountID (Mandatory) Specifies the account ID of the customer (for account activity report) /orderID (Mandatory) Specifies the order reference ID for the order {
"portfolioID": "100285-1",
"downloadTypeList": [
{
"downloadType": "Transactions Statement",
"downloadParams": {
"searchByInstrumentName": "",
"portfolioID": "100285-1",
"endDate": "2021-09-13",
"navPage": "Transactions",
"sortBy": "tradeDate",
"startDate": "2020-09-13"
}
},
{
"downloadType": "History Order Statement",
"downloadParams": {
"searchByInstrumentName": "",
"portfolioID": "100285-1",
"endDate": "2021-09-13",
"orderID": "2",
"navPage": "History Order",
"sortBy": "tradeDate",
"type": "History",
"startDate": "2020-09-13"
}
}
],
"reportTypeList": [
{
"reportType": "Holdings Summary",
"downloadParams": {
"searchByInstrumentName": "",
"portfolioID": "100285-1",
"navPage": "Holdings",
"sortBy": "description"
}
},
{
"reportType": "Accounts Activity Summary",
"downloadParams": {
"searchByInstrumentName": "",
"accountID": "11098",
"portfolioID": "100285-1",
"dateTo": "20210913",
"sortBy": "bookingDate",
"navPage": "Accounts Activity",
"dateFrom": "20200913",
"currencyID": "USD",
"listType": "SEARCH"
}
}
],
"opstatus": 0,
"navPage": "Reports",
"languagesList": [
{
"languageDescription": "English",
"languageCode": "EN"
}
],
"httpStatusCode": "200"
}
|
| Error Code(s): | Error Message: Unauthorized Access |
| Enterprise ProvIDer: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI field | Experience API field | Wealth FO API field |
|---|---|---|
| DownloadType | NA | |
| ReportType | NA | |
| LanguageDescription | NA | |
| LanguageCode | NA | |
| SearchByInstrumentName | NA | |
| PortfolioID | NA | |
| NavPage | NA | |
| DateTo | NA | |
| DateFrom | NA | |
| CurrencyID | NA | |
| ListType | NA | |
| StartDate | NA | |
| EndDate | NA | |
| Type | NA | |
| SortBy | NA | |
| AccountID | NA | |
| OrderID | NA |
Object Data Models
AccountActivity
| Parameter Name | DataType | Description |
|---|---|---|
| portfolioID | string | Specifies the ID field of the customers portfolio. |
| accountID | string | Specifies the account ID of the customer that is linked to the portfolio. |
| 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. |
| amount | string | Specifies the transaction amount. |
| balance | string | Specifies the running balance of the account. |
| quantity | string | Specifies the quantity of instrument brought/sold. |
| displayName | string | Specifies the transaction type for this particular account movement. |
| shortName | string | Specifies the instrument name. |
| currencyID | string | Specifies the currency of the account linked to the portfolio. |
| 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. |
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. |
FavouriteInstruments
| 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). |
| favInstrumentIDs | String | Specifies the comma seperated instrument IDs. |
| instrumentID | String | Specifies the ID of 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. |
MarketNews
| Parameter Name | DataType | Description |
|---|---|---|
| Topic | String | Specifies the news topics. |
| HL | String | Specifies an array of HeadlineMLTypeHL. |
| ID | String | Specifies the news story ID. |
| PR | String | Specifies the news provIDer. |
| LT | String | Specifies the local time of the news provIDer. |
| HT | String | Specifies the news headline text. |
| PE | String | PE values - multiple values are separated by a space. |
| pageSize | String | Specifies the number of records to be returned. |
| pageOffset | String | Specifies the index of the starting record. |
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. |
PortfolioPerformance
| Parameter Name | DataType | Description |
|---|---|---|
| portfolioID | String | Specifies the portfolio ID of the customer. |
| initialValue | String | Specifies the initial value of the portfolio for the time period chosen. |
| netDeposit | String | Specifies the cash inflow/outflow into the account for the time period chosen. |
| benchMarkIndex | String | Specifies the benchmark, which is used to compare with the portfolio performance. |
| duration | String | Specifies the duration for which the portfolio performance to be displayed. |
| pl | String | Specifies the PL for the time period chosen. |
| feesAndTax | String | Specifies the Fees and taxes for the time period chosen. |
| timeWeighted | String | Specifies the time weighted return for the portfolio. |
| moneyWeighted | String | Specifies the money weighted return for the portfolio. |
| portfolioReturn | String | Specifies the portfolio return for the portfolio. |
| dateTime | String | Specifies datetime. |
| referenceCurrency | String | Specifies the portfolio reference currency. |
| 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. |
| currentValue | String | Specifies the current value of the portfolio. |
| 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. |
| currencyID | String | Specifies the currency ID of the portfolio. |
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 currency 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. |
Reports
| Parameter Name | DataType | Description |
|---|---|---|
| portfolioID | String | Specifies the portfolio ID of the customer. |
| navPage | String | Specifies the page from which the service is been called. |
In this topic
