Portfolio Management
Name | Description | Introduced In |
---|---|---|
getDashboardGraph | 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 |
getRecentActivity | 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 or 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 |
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. | 2023.10 |
getTransactionDetails | This API retrieves the list of transactions of a portfolio. | 2021.04 |
getAccountActivity | 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 fields order. | 2021.04 |
getReportAndDownloadTypes | This API retrieves the list of reports to download. | 2021.04 |
computeStrategy | This API retrieves asset class-wise weightage. | 2023.01 |
getAllocationHC | This API retrieves the asset allocation data for the portfolio health. | 2023.01 |
getMyStrategy | This API retreives the strategy for the portfolio. | 2023.01 |
getPortfolioHealth | This API retreives the health of the portfolio. | 2023.01 |
getRcmdInstrumentIP | This API retreives asset class-wise weightage. | 2023.01 |
getRcmdInstrumentHC | This API retrieves asset class-wise weightage. | 2023.01 |
getStrategyAllocation | This API retrieves asset class-wise weightage. | 2023.01 |
getStrategyQuestions | This API retrieves asset class-wise weightage. | 2023.01 |
getPersonalizedStrategy | This API retrieves the strategy allocation data. | 2023.01 |
rejectProposal | This API rejects the investment proposal of a portfolio. | 2023.01 |
submitStrategyQuestionnaire | This API retrieves asset class-wise weightage. | 2023.01 |
confirmRcmdStrategy | This API retrieves used to update the recommended strategy to portfolio. | 2023.01 |
getAllStrategies | This API retrieves recommended and other strategy details. | 2023.01 |
getRcmdStrategy | This API retreives the strategy for the portfolio. | 2022.10 |
getSuitabilityProfile | This API retrieves the validity of the current portfolio. | 2022.10 |
getAllocation | This API retrieves the asset allocation details of the portfolio. | 2022.07 |
getPortfolioHealthIP | This API retrieves the health details if the proposed orders are accepted. | 2022.07 |
getInvestmentConstraintsHC | This API retrieves the investment constraints for the portfolio health. | 2022.07 |
getOrderProposal | This API retrieves the strategy for the portfolio. | 2022.07 |
getPastProposal | This API retrieves the past proposal for the Investment profile. | 2022.07 |
getPortfolioHealth | This api retrieves the health of the portfolio. | 2022.07 |
getRiskAnalysisHC | This API retrieves the risk details of the portfolio health. | 2022.07 |
getRiskAnalysisIP | This API retrieves the risk details of the portfolio health. | 2022.07 |
revertStrategy | This API is used to revert the personalized changes. | 2023.04 |
confirmOrdersIP | This API is used to confirm the orders of portfolio in the Investment Proposal. | 2023.04 |
getConstraintsIP | This API retrieves the constraints details for the Investment Proposal. | 2023.04 |
confirmStrategyQuestionnaire | This API is used to select strategy after answering the questionnaire. | 2023.04 |
confirmChangeStrategy | This API used to confirm the user selected strategy. | 2022.10 |
generatePastProposalPDF | This API retrieves the pdf base64 value for past proposal data. | 2022.07 |
getInstrumentTotal | This API retrieves the data for the portfolio graph. | 2021.04 |
getOrderDetails | This API retrieves the data portfolio orders. | 2021.04 |
getWealthDashboard | This API retrieves the portfolio list data and asset list data. | 2021.10 |
getCustomers | This API retrieves the list of customers and their asset values | 2024.04 |
updateFavoriteCustomer | This API is used to add or remove customer from favorites | 2024.04 |
Object Data Models | This Object Data Model describes the parameter name and other attribute details for Portfolio Management. | |
The "Value displayed in UI" is the actual output value in the UI field mapping. The UI field name is not displayed.

Description: | This API retrieves the investment details and the chart. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Dashboard/ getDashboardGraph |
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": "L", "referenceCurrency": "USD", "marketValue": "1001342.91", "todayPLAmount": "", "unRealizedPLPercentage": "52.35", "unRealizedPLAmount": "1100000.0", "todayPL": "", "opstatus": 0, "performanceValue": "-58.19", "performance": "YTD", "todayPLPercentage": "", "httpStatusCode": 200, "graphDuration": [ { "AMOUNT": "-500000.00", "TIMESTAMP": "2023-01-01", "PERCENTAGE": "0.00" }, { "AMOUNT": "-500000.00", "TIMESTAMP": "2023-01-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-500000.00", "TIMESTAMP": "2023-02-28", "PERCENTAGE": "0.00" }, { "AMOUNT": "-500000.00", "TIMESTAMP": "2023-03-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "1442102.91", "TIMESTAMP": "2023-04-30", "PERCENTAGE": "-39.79" }, { "AMOUNT": "1442102.91", "TIMESTAMP": "2023-05-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "1442102.91", "TIMESTAMP": "2023-06-30", "PERCENTAGE": "0.00" }, { "AMOUNT": "1442102.91", "TIMESTAMP": "2023-07-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "1442102.91", "TIMESTAMP": "2023-08-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "2101342.91", "TIMESTAMP": "2023-09-30", "PERCENTAGE": "45.71" }, { "AMOUNT": "2101342.91", "TIMESTAMP": "2023-10-31", "PERCENTAGE": "0.00" } ] } |
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 |
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 |

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: |
![]() 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 } ![]() 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 | Transact API 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 |

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 |
Market Price (Value only displayed in UI ) | TotalAssetValue | MVPortfolio |
NA | CustomerID | |
Unrealized P&L (Value only displayed in UI ) | unRealizedPLAmount | Total_PL |

Description: | This API retrieves the recent activity of the customer. | ||
Method: | POST | ||
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Dashboard/getRecentActivity | ||
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 |

Description: | This API retrieves the global indices along with the index value, gain or loss for the day, and the gain % or loss %. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/MarketData/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 |

Description: | This API retrieves the list of news for the specified topic. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/MarketData/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=\"contentRef\">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 |

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": "190345-3", "navPage": "Portfolio" } |
||
Response: |
![]() 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" } ![]() 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 YTD { "opstatus_getPayInstructions": 0, "referenceCurrency": "USD", "cashAccounts": [ { "balance": "-28140", "accountName": "GBP", "accountNameHyphenWithCurrency": "GBP GBP-GBP", "referenceCurrencyValue": "", "accountNameWithCurrency": "GBP GBP...GBP", "currency": "GBP", "accountNumber": "GBP" }, { "balance": "-2100000", "accountName": "Current Account", "accountNameHyphenWithCurrency": "USD Current Account-2898", "referenceCurrencyValue": "", "accountNameWithCurrency": "USD Current Account...2898", "currency": "USD", "accountNumber": "122898" } ], "instrumentTotal": [ { "unRealizedPL": "L", "referenceCurrency": "USD", "accountName": "My Investment Account 1", "YTD": [ { "AMOUNT": "-500000", "TIMESTAMP": "2023-01-01", "PERCENTAGE": "0.00" }, { "AMOUNT": "-500000", "TIMESTAMP": "2023-01-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-500000", "TIMESTAMP": "2023-02-28", "PERCENTAGE": "0.00" }, { "AMOUNT": "-500000", "TIMESTAMP": "2023-03-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-400000", "TIMESTAMP": "2023-04-30", "PERCENTAGE": "0.00" }, { "AMOUNT": "-400000", "TIMESTAMP": "2023-05-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-400000", "TIMESTAMP": "2023-06-30", "PERCENTAGE": "0.00" }, { "AMOUNT": "-400000", "TIMESTAMP": "2023-07-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-400000", "TIMESTAMP": "2023-08-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-200000", "TIMESTAMP": "2023-09-30", "PERCENTAGE": "-50.00" }, { "AMOUNT": "-200000", "TIMESTAMP": "2023-10-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "-1300000", "TIMESTAMP": "2023-11-15", "PERCENTAGE": "550.00" } ], "marketValue": "-1300000.00", "graphDuration": "YTD", "todayPLAmount": "", "accountNumber": "190345-3", "unRealizedPLPercentage": "107.69", "unRealizedPLAmount": "1400000.0", "portfolioID": "190345-3", "performance": "YTD", "todayPL": "", "performanceValue": "+112.50", "todayPLPercentage": "" } ], "totalMarketValue": "-1300000.00", "opstatus_getInstrumentTotal": 0, "totalCashBalanceCurrency": "", "opstatus_getAssetAllocation": 0, "portfolioID": "190345-3", "assets": [ { "assetGroup": "Others", "referenceCurrency": "USD", "marketValue": "-1271860" }, { "assetGroup": "Liquidity", "referenceCurrency": "USD", "marketValue": "-28140" } ], "opstatus_getCashAccounts": 0, "opstatus": 0, "totalCashBalance": "", "httpStatusCode": 200, "status": "success" } } 1Y { "opstatus_getPayInstructions": 0, "referenceCurrency": "USD", "cashAccounts": [ { "balance": "1199400", "accountName": "Current Account", "accountNameHyphenWithCurrency": "USD Current Account-2874", "referenceCurrencyValue": "", "accountNameWithCurrency": "USD Current Account...2874", "currency": "USD", "accountNumber": "122874" } ], "instrumentTotal": [ { "unRealizedPL": "P", "referenceCurrency": "USD", "accountName": "My Advisory Portfolio 1", "marketValue": "1199400.00", "graphDuration": "OneY", "todayPLAmount": "", "accountNumber": "190345-1", "unRealizedPLPercentage": "0.00", "unRealizedPLAmount": "0.0", "portfolioID": "190345-1", "performance": "1Y", "todayPL": "", "OneY": [ { "AMOUNT": "0", "TIMESTAMP": "2023-04-17", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-04-30", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-05-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-06-30", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-07-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-08-31", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-09-30", "PERCENTAGE": "0.00" }, { "AMOUNT": "1199400", "TIMESTAMP": "2023-10-12", "PERCENTAGE": "0.00" } ], "performanceValue": "0.00", "todayPLPercentage": "" } ], "totalMarketValue": "1199400.00", "opstatus_getInstrumentTotal": 0, "totalCashBalanceCurrency": "", "opstatus_getAssetAllocation": 0, "portfolioID": "190345-1", "assets": [ { "assetGroup": "Others", "referenceCurrency": "USD", "marketValue": "1199400" } ], "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 | MVPortfolio | ValuationAmt |
Unrealized PL (Value only displayed in UI) | unRealizedPLAmount | Total_PL | 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 |

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) |

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: |
![]() 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" } ![]() 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 |

Description: | This API generates PDF to download. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Reports/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 |

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": "660012-5", "userId": 3343013328, "fieldOrder": "fieldOrder", "navPage": "Holdings", "sortBy": "description", "pageSize": 20, "pageOffset": 0, "sortOrder": "DSC", "isEuro": "isEuro", "downloadFormat": "downloadFormat", "isIncludeOrders": "false" } |
||
Response: |
![]() 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": "USD", "accountNumber": "660012-5", "totalCount": "1", "portfolioID": "660012-5", "fieldstoDisplay": "holdingsId, holdingsType, marketPrice, ISIN, marketValPOS, weightPercentage, unrealPLMkt, region, assetClass, sector, secCCy, marketValue, costValue, unRealizedPLPercentage, quantity, costPrice, description, costValueSecCcy, unrealizedProfitLossSecCcy, unrealizedProfitLossPercentageSecCcy, exchangeRate, subAssetClass, , isinExchange, marketValueinsecCCy, status", "sortBy": "description", "status": "success", "portfolioHoldings": [ { "marketPrice": "20", "marketValPOS": "20000", "subAssetClass": "Shares", "costValue": "20372.03", "costValueSecCcy": "1", "weightPercentage": "20.07", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "-372.03", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "1000", "costPrice": "20", "assetClass": "Shares", "marketValue": "20000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "-1.83", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "20000", "isinExchange": "US1912161007 | XNYS" } ], "opstatus": 0, "httpStatusCode": 200 ![]() 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 { "referenceCurrency": "USD", "accountNumber": "660012-5", "totalCount": "6", "portfolioID": "660012-5", "fieldstoDisplay": "holdingsId, holdingsType, marketPrice, ISIN, marketValPOS, weightPercentage, unrealPLMkt, region, assetClass, sector, secCCy, marketValue, costValue, unRealizedPLPercentage, quantity, costPrice, description, costValueSecCcy, unrealizedProfitLossSecCcy, unrealizedProfitLossPercentageSecCcy, exchangeRate, subAssetClass, , isinExchange, marketValueinsecCCy, status", "sortBy": "description", "status": "success", "portfolioHoldings": [ { "marketPrice": "20", "marketValPOS": "20000", "subAssetClass": "Shares", "costValue": "20372.03", "costValueSecCcy": "1", "weightPercentage": "18.58", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "-372.03", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "1000", "costPrice": "20", "assetClass": "Shares", "marketValue": "20000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "-1.83", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "20000", "isinExchange": "US1912161007 | XNYS", "status": "" }, { "marketPrice": "20", "marketValPOS": "60000", "subAssetClass": "Shares", "costValue": "60000", "costValueSecCcy": "1", "weightPercentage": "55.75", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "0", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "3000", "costPrice": "20", "assetClass": "Shares", "marketValue": "60000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "0.00", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "60000", "isinExchange": "US1912161007 | XNYS", "status": "Open" }, { "marketPrice": "20", "marketValPOS": "4000", "subAssetClass": "Shares", "costValue": "4000", "costValueSecCcy": "1", "weightPercentage": "3.72", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "0", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "200", "costPrice": "20", "assetClass": "Shares", "marketValue": "4000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "0.00", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "4000", "isinExchange": "US1912161007 | XNYS", "status": "Open" }, { "marketPrice": "20", "marketValPOS": "-2000", "subAssetClass": "Shares", "costValue": "-10000", "costValueSecCcy": "1", "weightPercentage": "-1.86", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "8000", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "-100", "costPrice": "100", "assetClass": "Shares", "marketValue": "-2000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "-80.00", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "-2000", "isinExchange": "US1912161007 | XNYS", "status": "Open" }, { "marketPrice": "20", "marketValPOS": "10000", "subAssetClass": "Shares", "costValue": "10000", "costValueSecCcy": "1", "weightPercentage": "9.29", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "0", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "500", "costPrice": "20", "assetClass": "Shares", "marketValue": "10000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "0.00", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "10000", "isinExchange": "US1912161007 | XNYS", "status": "Open" }, { "marketPrice": "20", "marketValPOS": "40000", "subAssetClass": "Shares", "costValue": "40000", "costValueSecCcy": "1", "weightPercentage": "37.17", "description": "BG Coca-Cola", "unrealizedProfitLossSecCcy": "-", "holdingsId": "660010-106", "secCCy": "USD", "unrealPLMkt": "0", "exchangeRate": "1", "isSecurityAsset": "true", "unrealizedProfitLossPercentageSecCcy": "-", "sector": "Other Sectors", "quantity": "2000", "costPrice": "20", "assetClass": "Shares", "marketValue": "40000.00", "ISIN": "US1912161007", "unRealizedPLPercentage": "0.00", "application": "SC", "region": "North America", "holdingsType": "XNYS", "referenceCurrency": "USD", "marketValueinsecCCy": "40000", "isinExchange": "US1912161007 | XNYS", "status": "" } ], "opstatus": 0, "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 |
---|---|---|---|
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 |

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: |
![]() 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" } ![]() 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 |

Description: | This API retrieves the account activity of the portfolio. | ||
Method: | POST | ||
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/ getAccountActivity | ||
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: |
![]() 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 } ![]() 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 |

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: |
![]() 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" } ![]() 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 |

Description: | This API displays the investment performance. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/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 |

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 |

Description: | This API update or creates the fields order. |
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 |

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 |

Description: | This API retrieves asset class-wise weightage. |
Method: | POST |
URL: | {{URL}}/services/data/v1/PortfolioServicing/operations/Strategies/computeStrategy |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio ID (Mandatory) Specifies the unique ID field. Name (Mandatory) Specifies the name of the specific segment. targetWeight (Mandatory) Specifies the target weight of the specific segment. recommendedWeight (Mandatory) Specifies the recommended weight of the specific segment. UpdateCount (Mandatory) Specifies the update count of the specific segment. { "portfolioId": "190399-11", "ID": "3", "Name": "en_IRS_Stock_TC01", "targetWeight": "58.00", "recommendedWeight": "40.00", "UpdateCount": "0", "portfolioServiceType": "Advisory", "marketSegmentId": "3015", "portfolioCode": "40081", "isCustomized": "true" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /updateCount (Mandatory) Specifies the update count of the specific segment. /personalizedStrategy (Mandatory) Response object is mandatory. /recommendedWeight (Mandatory) Specifies the recommended weight of the specific segment. /targetWeight (Mandatory) Specifies the target weight of the specific segment. /Name (Mandatory) Specifies the name of the specific segment. /level (Mandatory) Specifies the level of the specific segment. /parentID (Mandatory) Specifies the parent id of the specific segment. /ID (Mandatory) Specifies the unique ID of the specific segment. /isCustomized (Mandatory) Specifies whether the specific segment is customized or not. /marketSegmentId (Mandatory) Specifies the id of the specific market segment. { "status": "success", "httpStatusCode": 200, "opstatus": 1582, "personalizedStrategy": [ { "recommendedWeight": "40", "targetWeight": "58.0", "Name": "en_IRS_Stock_TC01", "level": "1", "parentId": "2", "ID": "3", "isCustomized": "true", "marketSegmentId": "3015" }, { "recommendedWeight": "20", "targetWeight": "14.0", "Name": "en_IRS_FUNDS_TC01", "level": "1", "parentId": "2", "ID": "4", "isCustomized": "false", "marketSegmentId": "3017" }, { "recommendedWeight": "30", "targetWeight": "21.0", "Name": "en_IRS_BONDS_TC01", "level": "1", "parentId": "2", "ID": "5", "isCustomized": "false", "marketSegmentId": "3016" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "en_IRS_CASH_TC01", "level": "1", "parentId": "2", "ID": "6", "isCustomized": "false", "marketSegmentId": "3018" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "1", "parentId": "2", "ID": "7", "isCustomized": "false", "marketSegmentId": "3019" }, { "recommendedWeight": "30", "targetWeight": "43.5", "Name": "en_IRS_NA_TC01", "level": "2", "parentId": "3", "ID": "11", "isCustomized": "false", "marketSegmentId": "3023" }, { "recommendedWeight": "20", "targetWeight": "14.0", "Name": "en_IRS_NA_TC01", "level": "2", "parentId": "5", "ID": "12", "isCustomized": "false", "marketSegmentId": "3027" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "en_IRS_NA_TC01", "level": "2", "parentId": "4", "ID": "13", "isCustomized": "false", "marketSegmentId": "3031" }, { "recommendedWeight": "10", "targetWeight": "14.5", "Name": "IRS_EUROPE_TC01", "level": "2", "parentId": "3", "ID": "14", "isCustomized": "false", "marketSegmentId": "3022" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "en_IRS_EUROPE_TC01", "level": "2", "parentId": "5", "ID": "15", "isCustomized": "false", "marketSegmentId": "3026" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "en_IRS_EUROPE_TC01", "level": "2", "parentId": "4", "ID": "16", "isCustomized": "false", "marketSegmentId": "3030" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "2", "parentId": "3", "ID": "17", "isCustomized": "false", "marketSegmentId": "3021" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "2", "parentId": "5", "ID": "18", "isCustomized": "false", "marketSegmentId": "3025" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "2", "parentId": "4", "ID": "19", "isCustomized": "false", "marketSegmentId": "3029" }, { "recommendedWeight": "15", "targetWeight": "21.75", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "11", "ID": "26", "isCustomized": "false", "marketSegmentId": "3034" }, { "recommendedWeight": "7", "targetWeight": "10.15", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "14", "ID": "27", "isCustomized": "false", "marketSegmentId": "3038" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "12", "ID": "28", "isCustomized": "false", "marketSegmentId": "3042" }, { "recommendedWeight": "5", "targetWeight": "3.5", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "15", "ID": "29", "isCustomized": "false", "marketSegmentId": "3046" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "13", "ID": "30", "isCustomized": "false", "marketSegmentId": "3050" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "16", "ID": "31", "isCustomized": "false", "marketSegmentId": "3054" }, { "recommendedWeight": "15", "targetWeight": "21.75", "Name": "en_IRS_SECTOR_90_TC01", "level": "3", "parentId": "11", "ID": "32", "isCustomized": "false", "marketSegmentId": "3035" }, { "recommendedWeight": "3", "targetWeight": "4.35", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "14", "ID": "33", "isCustomized": "false", "marketSegmentId": "3039" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "12", "ID": "34", "isCustomized": "false", "marketSegmentId": "3043" }, { "recommendedWeight": "5", "targetWeight": "3.5", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "15", "ID": "35", "isCustomized": "false", "marketSegmentId": "3047" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "13", "ID": "36", "isCustomized": "false", "marketSegmentId": "3051" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "16", "ID": "37", "isCustomized": "false", "marketSegmentId": "3055" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "3", "parentId": "11", "ID": "38", "isCustomized": "false", "marketSegmentId": "3033" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "3", "parentId": "14", "ID": "39", "isCustomized": "false", "marketSegmentId": "3037" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "3", "parentId": "12", "ID": "40", "isCustomized": "false", "marketSegmentId": "3041" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "3", "parentId": "15", "ID": "41", "isCustomized": "false", "marketSegmentId": "3045" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "3", "parentId": "13", "ID": "42", "isCustomized": "false", "marketSegmentId": "3049" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "3", "parentId": "16", "ID": "43", "isCustomized": "false", "marketSegmentId": "3053" }, { "recommendedWeight": "15", "targetWeight": "21.75", "Name": "IS_MP_STNA300", "level": "4", "parentId": "26", "ID": "44", "isCustomized": "false" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "IS_MP_BONA300", "level": "4", "parentId": "28", "ID": "45", "isCustomized": "false" }, { "recommendedWeight": "10", "targetWeight": "7.0", "Name": "IS_MP_FUNA300", "level": "4", "parentId": "30", "ID": "46", "isCustomized": "false" }, { "recommendedWeight": "6", "targetWeight": "8.7", "Name": "DC STNA300 Amazon", "level": "4", "parentId": "26", "ID": "49", "isCustomized": "false" }, { "recommendedWeight": "4.5", "targetWeight": "6.53", "Name": "DC STNA300 Alphabet", "level": "4", "parentId": "26", "ID": "50", "isCustomized": "false" }, { "recommendedWeight": "4.5", "targetWeight": "6.53", "Name": "DC STNA300 Accenture", "level": "4", "parentId": "26", "ID": "51", "isCustomized": "false" }, { "recommendedWeight": "4", "targetWeight": "2.8", "Name": "DC BONA300 Basf", "level": "4", "parentId": "28", "ID": "52", "isCustomized": "false" }, { "recommendedWeight": "3", "targetWeight": "2.1", "Name": "DC BONA300 Citicorp", "level": "4", "parentId": "28", "ID": "53", "isCustomized": "false" }, { "recommendedWeight": "3", "targetWeight": "2.1", "Name": "DC BONA300 Daimler AG", "level": "4", "parentId": "28", "ID": "54", "isCustomized": "false" }, { "recommendedWeight": "4", "targetWeight": "2.8", "Name": "DC FUNA300 JPMC", "level": "4", "parentId": "30", "ID": "55", "isCustomized": "false" }, { "recommendedWeight": "3.5", "targetWeight": "2.45", "Name": "DC FUNA300 Scb Mutual Fund", "level": "4", "parentId": "30", "ID": "56", "isCustomized": "false" }, { "recommendedWeight": "2.5", "targetWeight": "1.75", "Name": "DC FUNA300 Uk Mutual Fund", "level": "4", "parentId": "30", "ID": "57", "isCustomized": "false" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "Current Account", "level": "2", "parentId": "6", "ID": "60", "isCustomized": "false" } ] } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
|
Enterprise API: |
|
Field Mapping
No field Mappings for this API

Description: | This API retrieves the asset allocation data for the portfolio health. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioHealth/getAllocationHC |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /Assests (Mandatory) Specifies the JSON Array containing the asset details. /currentWeight (Mandatory) Specifies the current weight by region. /level (Mandatory) Specifies the level of the specific segment. /strategyWeight (Mandatory) Specifies the strategy weight by region. /parentID (Mandatory) Specifies the ID of the upper asset class. /ID (Mandatory) Specifies a unique ID of the each asset name. /Name (Mandatory) Specifies the name of the asset class. /healthStatus (Mandatory) Specifies the status of health parameters. { "status": "success", "httpStatusCode": 200, "opstatus": 0, "Assets": [ { "currentWeight": "6.39", "level": "0", "strategyWeight": "7.00", "parentId": "0", "ID": "1", "Name": "Fund", "healthStatus": "0" }, { "currentWeight": "6.39", "level": "1", "strategyWeight": "7.00", "parentId": "1", "ID": "2", "Name": "US", "healthStatus": "0" }, { "currentWeight": "6.39", "level": "2", "strategyWeight": "7.00", "parentId": "2", "ID": "3", "Name": "Exchange Traded Funds", "healthStatus": "0" }, { "currentWeight": "90.96", "level": "0", "strategyWeight": "90.00", "parentId": "0", "ID": "4", "Name": "Share", "healthStatus": "0" }, { "currentWeight": "3.87", "level": "1", "strategyWeight": "5.00", "parentId": "4", "ID": "5", "Name": "EU", "healthStatus": "0" }, { "currentWeight": "3.87", "level": "2", "strategyWeight": "5.00", "parentId": "5", "ID": "6", "Name": "Retail", "healthStatus": "0" }, { "currentWeight": "76.27", "level": "1", "strategyWeight": "75.00", "parentId": "4", "ID": "7", "Name": "US", "healthStatus": "0" }, { "currentWeight": "0.23", "level": "2", "strategyWeight": "2.00", "parentId": "7", "ID": "8", "Name": "Auto & Truck Manufacturers", "healthStatus": "0" }, { "currentWeight": "0.55", "level": "2", "strategyWeight": "0.50", "parentId": "7", "ID": "9", "Name": "Beverages (Nonalcoholic)", "healthStatus": "0" }, { "currentWeight": "1.06", "level": "2", "strategyWeight": "1.20", "parentId": "7", "ID": "10", "Name": "Communications Equipment", "healthStatus": "0" }, { "currentWeight": "6.30", "level": "2", "strategyWeight": "1.30", "parentId": "7", "ID": "11", "Name": "Computer Services", "healthStatus": "0" }, { "currentWeight": "0.68", "level": "2", "strategyWeight": "2.50", "parentId": "7", "ID": "12", "Name": "Consumer Financial Services", "healthStatus": "0" }, { "currentWeight": "67.44", "level": "2", "strategyWeight": "67.50", "parentId": "7", "ID": "13", "Name": "Retail", "healthStatus": "0" }, { "currentWeight": "10.82", "level": "1", "strategyWeight": "10.00", "parentId": "4", "ID": "14", "Name": "Other Regions", "healthStatus": "0" }, { "currentWeight": "2.65", "level": "0", "strategyWeight": "3.00", "parentId": "0", "ID": "15", "Name": "Other Assets", "healthStatus": "0" } ] } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth Front Office (FO) |
Enterprise API: |
Wealth Front Office (FO): v1.0.0/holdings/portfolios/$portfolioId/checkStrategy |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Weight | strategyWeight | OBJECTIVE_WEIGHT |
Segment | Name | MKT_SEGMENT |
currentWeight | OBJ_ACTUAL_WEIGHT | |
level | LEVEL_N | |
parentId | PARENT_ID | |
ID | ID | |
Indicator | healthStatus | OBJ_COMPLIANCE_INDICATOR |

Description: | This API retrieves the the strategy for the portfolio. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Strategies/getMyStrategy |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } ![]() Parameters /portfolioId (Mandatory) Specifies the ID of customer’s portfolio. /portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "190332-1" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /isNewUser (Mandatory) Specifies whether the customer is new or not. /strategyID (Mandatory) Specifies a unique ID for a strategy. /myStrategyName (Mandatory) Specifies the strategy name. /myRisklevel (Mandatory) Specifies the risk level. /strategylist (Mandatory) Specifies the list of strategies. /strategyName (Mandatory) Specifies the strategy name depending on the value of risk level. /minVal (Mandatory) Specifies a minimum value of that strategy. /maxVal (Mandatory) Specifies a maximum value of that strategy. /assests (Mandatory) Specifies the JSON Array containing the asset details. /assetName (Mandatory) Specifies the asset name. /weight (Mandatory) Specifies the weight of different assets. { "status": "success", "isNewUser": "false", "strategyId": "781", "myStrategyName": "Active", "myRiskLevel": "28", "strategyList": [ { "strategyName": "Secure", "minVal": "0", "maxVal": "14" }, { "strategyName": "Conservative", "minVal": "15", "maxVal": "17" }, { "strategyName": "Balanced", "minVal": "18", "maxVal": "24" }, { "strategyName": "Active", "minVal": "25", "maxVal": "32" }, { "strategyName": "Dynamic", "minVal": "33", "maxVal": "40" } ], "assets": [ { "assetName": "Stocks", "weight": "40.00" }, { "assetName": "Bonds", "weight": "30.00" }, { "assetName": "Cash", "weight": "10.00" }, { "assetName": "Funds", "weight": "20.00" } ], "opstatus": 0, "httpStatusCode": 200 } ![]() Parameters /status (Mandatory) Specifies whether the service is success or not. /isNewUser (Mandatory) Specifies whether the customer is new or not. /strategyID (Mandatory) Specifies a unique ID for a strategy. /myStrategyName (Mandatory) Specifies the name of the strategy. /myRisklevel (Mandatory) Specifies the risk level. /strategylist (Mandatory) Specifies the list of strategies. /strategyName (Mandatory) Specifies the strategy name depending on the value of risk level. /minVal (Mandatory) Specifies a minimum value of that strategy. /maxVal (Mandatory) Specifies a maximum value of that strategy. /assests (Mandatory) Specifies the JSON Array containing the asset details. /assetName (Mandatory) Specifies the asset name. /weight (Mandatory) Identifies the weight of different assets. "status": "success", "isNewUser": "false", "strategyId": "IRS_IP_CONSERVATIVE", "myStrategyName": "Conservative", "myRiskLevel": "15", "strategyList": [ { "strategyName": "Secure", "minVal": "0", "maxVal": "14" }, { "strategyName": "Conservative", "minVal": "15", "maxVal": "17" }, { "strategyName": "Balanced", "minVal": "18", "maxVal": "24" }, { "strategyName": "Active", "minVal": "25", "maxVal": "32" }, { "strategyName": "Dynamic", "minVal": "33", "maxVal": "40" } ], "assets": [ { "assetName": "IRS_Stock_TC04", "weight": "20" }, { "assetName": "IRS_FUNDS_TC04", "weight": "30" }, { "assetName": "IRS_BONDS_TC04", "weight": "20" }, { "assetName": "IRS_CASH_TC04", "weight": "30" }, { "assetName": "IRS_OTHERS_TC04", "weight": "0" } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Details | assetName | MKT_SEGMENT |
weight | OBJECTIVE_WEIGHT |

Description: | This API retrieves the health of the portfolio. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioHealth/getPortfolioHealth |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } ![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "190332-1" "portfolioServiceType": "Advisory" } |
Response: |
![]() Parameters /status (Mandatory) Specifies whether the service is success or not. /portfolioHealth (Mandatory) Specifies the JSON Array containing the health parameters. /healthStatus (Mandatory) Specifies the status of health parameters. /healthParameter (Mandatory) Specifies the parameters of Portfolio. { "status": "success", "portfolioHealth": [ { "healthStatus": "0", "healthParameter": "Asset Allocation" }, { "healthStatus": "0", "healthParameter": "Risk Analysis" }, { "healthStatus": "0", "healthParameter": "Investment Constraints" }, { "healthStatus": "0", "healthParameter": "Recommended Instruments" } ], "opstatus": 0, "httpStatusCode": 200 } ![]() Parameters /status (Mandatory) Specifies whether the service is success or not. /portfolioHealth (Mandatory) JSON Array containing the health parameters. /healthStatus (Mandatory) Specifies the status of health parameters. /healthParameter (Mandatory) Specifies the parameters to display the status of Portfolio. { "status": "success", "portfolioHealth": [ { "healthStatus": "0", "healthParameter": "Asset Allocation" }, { "healthStatus": "0", "healthParameter": "Risk Analysis" }, { "healthStatus": "0", "healthParameter": "Investment Constraints" }, { "healthStatus": "0", "healthParameter": "Recommended Instruments" } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): |
Error Message Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Asset Allocation | healthStatus | AllObjectiveComplianceE |
Risk Analysis | healthStatus | MainRiskComplianceE |
Investment Constraints | healthStatus | AllConstraintComplianceE |
Recommended Instruments | healthStatus | recomNatE |
Names | healthParameter |

Description: | This API retrieves the instrument details. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/getRcmdInstrumentIP |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio Type (Mandatory) Specifies the type of customer’s portfolio. { "portfolioId": "100777-5", "portfolioServiceType": "Advisory", "type": "PastProposal" } ![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "190332-1", "portfolioServiceType": "Advisory" } |
Response: |
![]() Parameters /status (Mandatory) Specifies whether the service is success or not. /opstatus (Mandatory) Specifies the opstatus. /recommendedInstrumentStatus (Mandatory) Specifies the status of the instrument of the desired portfolio. /recommendedInstrumentComment (Mandatory) Specifies whether the changes are required in the instrument or not. /recommendedInstrumentDetails (Mandatory) Specifies the status of the instrument of the desired portfolio. { "status": "success", "opstatus": 0, "httpStatusCode": 200, "recommendedDetails": [ { "recommendedInstrumentComment": "No issues", "recommendedInstrumentStatus": "0", "recommendedInstrumentDetails": [] } ] } ![]() { "status": "success", "opstatus": 0, "httpStatusCode": 200, "recommendedDetails": [ { "recommendedInstrumentComment": "No issues", "recommendedInstrumentStatus": "0", "recommendedInstrumentDetails": [] } ] } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/reference/strategies/investmentProfileStrategyDetail/$portfolioId |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Details | instrumentDetails |
recomNatL instrumentName valueN |
instrumentName | instrumentName |

Description: | This API retrieves the instrument details. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/PortfolioHealth/getRcmdInstrumentHC |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "100777-5", "portfolioServiceType": "Advisory", } ![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. Type (Mandatory)Specifies the type of customer’s portfolio. { "portfolioId": "190332-1", "portfolioServiceType": "Advisory", "type": "PastProposal" } |
Response: |
![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio /recommendedInstrumentComment (Mandatory) Specifies whether the changes are required in the instrument or not. /recommendedInstrumentStatus (Mandatory) Specifies the status of the instrument of the desired portfolio. /status (Mandatory) Specifies whether the service is success or not. /recommendedInstrumentDetails (Mandatory) Specifies all the details of the instrument. /instrumentName (Mandatory) Specifies the Name of the instrument. { "portfolioID": "100777-5", "recommendedInstrumentComment": "Some issues with your portfolio health", "recommendedInstrumentStatus": "1", "status": "success", "recommendedInstrumentDetails": [ { "instrumentName": "Alphabet", "instrumentDetails": "Alphabet position held; has Sell recommendation" }, { "instrumentName": "Pfizer Inc", "instrumentDetails": "Pfizer Inc position held; not included within Bank recommendation" } ], "opstatus": 0, "httpStatusCode": 200 } ![]() { "portfolioID": "190332-1", "recommendedInstrumentComment": "No issues", "recommendedInstrumentStatus": "0", "status": "success", "recommendedInstrumentDetails": [], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/reference/strategies/investmentProfileStrategyDetail/$portfolioId |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Details | instrumentDetails |
recomNatL instrumentName valueN |
instrumentName | instrumentName |

Description: | This API retrieves allocation for that strategy. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Strategies/getStrategyAllocation |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "100777-5", "portfolioServiceType": "Advisory", } ![]() Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "190332-1", "portfolioServiceType": "Advisory", } |
Response: |
![]() Parameters /status (Mandatory) Specifies the success or the error status of the service. /strategyAlloc (Mandatory) Specifies the JSON array that contains the strategyalloc details. /strategyWeight (Mandatory) Specifies a weight value of that strategy. /name (Mandatory) Specifies the name of the asset. /level (Mandatory) Indicates the level in which the asset is placed. /ID (Mandatory) Specifies the unique ID of the asset object. { "status": "success", "httpStatusCode": 200, "opstatus": 0, "strategyAlloc": [ { "strategyWeight": "25.00", "name": "Funds", "level": "0", "parentId": "1", "ID": "2" }, { "strategyWeight": "25.00", "name": "Stocks", "level": "0", "parentId": "1", "ID": "3" }, { "strategyWeight": "25.00", "name": "Bonds", "level": "0", "parentId": "1", "ID": "4" }, { "strategyWeight": "25.00", "name": "Cash", "level": "0", "parentId": "1", "ID": "5" }, { "strategyWeight": "25.00", "name": "US", "level": "1", "parentId": "2", "ID": "6" }, { "strategyWeight": "10.00", "name": "EU", "level": "1", "parentId": "3", "ID": "7" }, { "strategyWeight": "15.00", "name": "US", "level": "1", "parentId": "3", "ID": "8" }, { "strategyWeight": "20.00", "name": "US", "level": "1", "parentId": "4", "ID": "9" }, { "strategyWeight": "5.00", "name": "EU", "level": "1", "parentId": "4", "ID": "10" }, { "strategyWeight": "25.00", "name": "Exchange Traded Funds", "level": "2", "parentId": "6", "ID": "11" }, { "strategyWeight": "10.00", "name": "Retail", "level": "2", "parentId": "7", "ID": "12" }, { "strategyWeight": "1.50", "name": "Aerospace & Defense", "level": "2", "parentId": "8", "ID": "13" }, { "strategyWeight": "2.50", "name": "Auto & Truck Manufacturers", "level": "2", "parentId": "8", "ID": "14" }, { "strategyWeight": "1.50", "name": "Beverages (Nonalcoholic)", "level": "2", "parentId": "8", "ID": "15" }, { "strategyWeight": "2.75", "name": "Biotechnology & Drugs", "level": "2", "parentId": "8", "ID": "16" }, { "strategyWeight": "1.25", "name": "Communications Equipment", "level": "2", "parentId": "8", "ID": "17" }, { "strategyWeight": "1.50", "name": "Computer Services", "level": "2", "parentId": "8", "ID": "18" }, { "strategyWeight": "2.00", "name": "Consumer Financial Services", "level": "2", "parentId": "8", "ID": "19" }, { "strategyWeight": "1.00", "name": "Regional Banks", "level": "2", "parentId": "8", "ID": "20" }, { "strategyWeight": "1.00", "name": "Retail", "level": "2", "parentId": "8", "ID": "21" }, { "strategyWeight": "10.00", "name": "Consumer Financial Services", "level": "2", "parentId": "9", "ID": "22" }, { "strategyWeight": "5.00", "name": "Regional Banks", "level": "2", "parentId": "9", "ID": "23" }, { "strategyWeight": "5.00", "name": "Retail", "level": "2", "parentId": "9", "ID": "24" }, { "strategyWeight": "2.50", "name": "Aerospace & Defense", "level": "2", "parentId": "10", "ID": "25" }, { "strategyWeight": "0.50", "name": "Auto & Truck Manufacturers", "level": "2", "parentId": "10", "ID": "26" }, { "strategyWeight": "2.00", "name": "Beverages (Nonalcoholic)", "level": "2", "parentId": "10", "ID": "27" } ] } ![]() { "status": "success", "httpStatusCode": 200, "opstatus": 0, "strategyAlloc": [ { "strategyWeight": "100", "name": "IRS_ALC_CONSERVATIVE", "level": "0", "parentId": "1", "ID": "2" }, { "strategyWeight": "20", "name": "IRS_Stock_TC04", "level": "1", "parentId": "2", "ID": "3" }, { "strategyWeight": "30", "name": "IRS_FUNDS_TC04", "level": "1", "parentId": "2", "ID": "4" }, { "strategyWeight": "20", "name": "IRS_BONDS_TC04", "level": "1", "parentId": "2", "ID": "5" }, { "strategyWeight": "30", "name": "IRS_CASH_TC04", "level": "1", "parentId": "2", "ID": "6" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "1", "parentId": "2", "ID": "7" }, { "strategyWeight": "10", "name": "IRS_NA_TC04", "level": "2", "parentId": "3", "ID": "11" }, { "strategyWeight": "7", "name": "IRS_NA_TC04", "level": "2", "parentId": "5", "ID": "12" }, { "strategyWeight": "15", "name": "IRS_NA_TC04", "level": "2", "parentId": "4", "ID": "13" }, { "strategyWeight": "10", "name": "IRS_EUROPE_TC04", "level": "2", "parentId": "3", "ID": "14" }, { "strategyWeight": "13", "name": "IRS_EUROPE_TC04", "level": "2", "parentId": "5", "ID": "15" }, { "strategyWeight": "15", "name": "IRS_EUROPE_TC04", "level": "2", "parentId": "4", "ID": "16" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "2", "parentId": "3", "ID": "17" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "2", "parentId": "5", "ID": "18" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "2", "parentId": "4", "ID": "19" }, { "strategyWeight": "5", "name": "IRS_SECTOR_300_TC04", "level": "3", "parentId": "11", "ID": "26" }, { "strategyWeight": "5", "name": "IRS_SECTOR_300_TC04", "level": "3", "parentId": "14", "ID": "27" }, { "strategyWeight": "4", "name": "IRS_SECTOR_300_TC04", "level": "3", "parentId": "12", "ID": "28" }, { "strategyWeight": "10", "name": "IRS_SECTOR_300_TC04", "level": "3", "parentId": "15", "ID": "29" }, { "strategyWeight": "10", "name": "IRS_SECTOR_300_TC04", "level": "3", "parentId": "13", "ID": "30" }, { "strategyWeight": "10", "name": "IRS_SECTOR_300_TC04", "level": "3", "parentId": "16", "ID": "31" }, { "strategyWeight": "5", "name": "IRS_SECTOR_90_TC04", "level": "3", "parentId": "11", "ID": "32" }, { "strategyWeight": "5", "name": "IRS_SECTOR_90_TC04", "level": "3", "parentId": "14", "ID": "33" }, { "strategyWeight": "3", "name": "IRS_SECTOR_90_TC04", "level": "3", "parentId": "12", "ID": "34" }, { "strategyWeight": "3", "name": "IRS_SECTOR_90_TC04", "level": "3", "parentId": "15", "ID": "35" }, { "strategyWeight": "5", "name": "IRS_SECTOR_90_TC04", "level": "3", "parentId": "13", "ID": "36" }, { "strategyWeight": "5", "name": "IRS_SECTOR_90_TC04", "level": "3", "parentId": "16", "ID": "37" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "3", "parentId": "11", "ID": "38" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "3", "parentId": "14", "ID": "39" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "3", "parentId": "12", "ID": "40" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "3", "parentId": "15", "ID": "41" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "3", "parentId": "13", "ID": "42" }, { "strategyWeight": "0", "name": "IRS_OTHERS_TC04", "level": "3", "parentId": "16", "ID": "43" }, { "strategyWeight": "10", "name": "IRS_FUNA300_MP", "level": "4", "parentId": "30", "ID": "44" }, { "strategyWeight": "10", "name": "INW FUNA300 TC224", "level": "4", "parentId": "30", "ID": "45" }, { "strategyWeight": "0", "name": "INW FUNA90 TC224 (Sent)", "level": "4", "parentId": "36", "ID": "46" }, { "strategyWeight": "0", "name": "Current Account", "level": "2", "parentId": "6", "ID": "47" }, { "strategyWeight": "0", "name": "Current Account", "level": "3", "parentId": "47", "ID": "48" }, { "strategyWeight": "0", "name": "Current Account (Sent)", "level": "3", "parentId": "47", "ID": "49" } ] } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/holdings/portfolios/$portfolioId/$strategyId/checkStrategy |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Segment | name |
MKT_SEGMENT |
Weight | strategyWeight | OBJECTIVE_WEIGHT |

Description: | This API retrieves the question code of the strategy. |
Method: | POST |
URL: | {{URL}}/services/data/v1/PortfolioServicing/operations/Strategies/getStrategyQuestions |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "100777-4", "portfolioServiceType": "Advisory", } |
Response: |
Parameters /status (Mandatory) Specifies the success or the error status of the service. /code (Mandatory) Specifies the strategy code. /questions (Mandatory) Specifies the JSON array that contains the questions details. /questioncode (Mandatory) Determines the question code for object. /option (Mandatory) Specifies the JSON array that contains the option details. /desc (Mandatory) Specifies the description for an answer. /defValueF (Mandatory) Specifies the indication for an answer. /name (Mandatory) Specifies the answer field. { "status": "success", "code": "PCK_DS_INVEST_PROF", "questions": [ { "question": "You fall within the age category of?", "questionCode": "Age Category", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "18 to below 30", "defValueF": "false", "name": "18_TO_BELOW_30" }, { "desc": "30 to below 40", "defValueF": "false", "name": "30_TO_BELOW_40" }, { "desc": "40 to below 50", "defValueF": "false", "name": "40_TO_BELOW_50" }, { "desc": "50 to below 60", "defValueF": "false", "name": "50_TO_BELOW_60" }, { "desc": "60 & Above", "defValueF": "false", "name": "60_AND_ABOVE" } ] }, { "question": "For how long would you expect most of your money to be invested before you would need to access it?", "questionCode": "investment_period", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "Less than 3 years", "defValueF": "false", "name": "LESS_THAN_3_YEARS" }, { "desc": "Between 3 & 5 years", "defValueF": "false", "name": "BETWEEN_3_AND_5_YEARS" }, { "desc": "Between 5 & 10 years", "defValueF": "false", "name": "BETWEEN_5_AND_10_YEARS" }, { "desc": "10 years & above", "defValueF": "false", "name": "10_YEARS_AND_ABOVE" } ] }, { "question": "What would you do with your investment if the market falls?", "questionCode": "Market Fall Behaviour", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "I am willing to accept minimal declines in the value of my investments, as capital preservation is my primary objective.", "defValueF": "false", "name": "ACCEPT_MINIMAL_DECLINES" }, { "desc": "I am willing to accept some declines, but I am not comfortable with moderate to extreme drops in the value of my investments.", "defValueF": "false", "name": "ACCEPT_SOME_DECLINES" }, { "desc": "I am willing to accept moderate declines, but I am not comfortable with extreme drops in the value of my investments.", "defValueF": "false", "name": "ACCEPT_MODERATE_DECLINES" }, { "desc": "I am prepared to take losses and large fluctuations in the value of my investments in order to maximize my long term returns.", "defValueF": "false", "name": "TAKE_LOSSES_AND_LARGE_FLUCT" } ] }, { "question": "How easily can you meet your unforeseen financial needs without liquidating your current investment?", "questionCode": "financial_needs", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "It would be difficult with some planning.", "defValueF": "false", "name": "DIFFICULT" }, { "desc": "Easily with some planning.", "defValueF": "false", "name": "EASILY" }, { "desc": "It would be very difficult with some planning.", "defValueF": "false", "name": "VERY_DIFFICULT" }, { "desc": "Very easily after some planning.", "defValueF": "false", "name": "VERY_EASILY" } ] }, { "question": "How would you best describe your income expectations over the next five years?", "questionCode": "income_expectation", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "I expect my income to fall (as a result of retirement, reduced working-hours etc.).", "defValueF": "false", "name": "FALL" }, { "desc": "My income fluctuates from year to year (e.g. for self-employed investors).", "defValueF": "false", "name": "FLUCTUATE_FROM_YEAR_TO_YEAR" }, { "desc": "I expect my income to keep pace with inflation.", "defValueF": "false", "name": "KEEP_PACE_WITH_INFLATION" }, { "desc": "I expect my income to rise well ahead of inflation (through promotion, career developments etc.).", "defValueF": "false", "name": "RISE_WELL_AHEAD_OF_INFLATION" } ] }, { "question": "How would you describe your knowledge of investments?", "questionCode": "investment_knowledge", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "Extensive", "defValueF": "false", "name": "EXTENSIVE" }, { "desc": "Good", "defValueF": "false", "name": "GOOD" }, { "desc": "Limited", "defValueF": "false", "name": "LIMITED" }, { "desc": "None", "defValueF": "false", "name": "NONE" } ] }, { "question": "What is your primary objective for Investment?", "questionCode": "investment_objective", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "Preservation of capital with minimal opportunity for capital growth.", "defValueF": "false", "name": "CAPITAL_PRESERVATION" }, { "desc": "High capital appreciation with minimum income generation.", "defValueF": "false", "name": "HIGH_CAPITAL_APPRECIATION" }, { "desc": "Generate a stream of income with less emphasis on capital appreciation.", "defValueF": "false", "name": "STEADY_CAPITAL_APPRECIATION" }, { "desc": "Steady capital appreciation with less emphasis on income generation.", "defValueF": "false", "name": "GOOD" } ] }, { "question": "What is the maximum loss that you can tolerate (within 1 year) in a worst case scenario?", "questionCode": "max_loss_tolerance_capacity", "option": [ { "desc": "Not Defined", "defValueF": "false", "name": "NOTDEFINED" }, { "desc": "Between 10% and 20%", "defValueF": "false", "name": "BETWEEN_10_AND_20" }, { "desc": "Between 20% and 25%", "defValueF": "false", "name": "BETWEEN_20_AND_25" }, { "desc": "Between 3% and 10%", "defValueF": "false", "name": "BETWEEN_3_AND_10" }, { "desc": "Less than 3%", "defValueF": "false", "name": "LESS_THAN_3_PERCENT" }, { "desc": "Over 25%", "defValueF": "false", "name": "OVER_25_PERCENT" } ] } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/system/questionnaires/$code |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Questions | question | Label/ denom |
questionCode | name | |
Option | permValues | |
Options for answer | Name |
permValues /label / denom |
desc |
permValues /label / name |

Description: | This API retrieves the strategy allocation data. |
Method: | POST |
URL: | {{URL}}/services/data/v1/PortfolioServicing/operations/Strategies/getPersonalizedStrategy |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "190399-11", "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the success or the error status of the service. /personalizedStrategy (Mandatory) Specifies the JSON array that contains the personalizedStrategy details. /recommendedWeight (Mandatory) Specifies the recommendedweight value for that Strategy. /targetWeight (Mandatory) Specifies the targetweight value for that Strategy. /Name (Mandatory) Specifies the name of the asset. /level (Mandatory) Indicates the level in which the asset is placed. /parentId (Mandatory) Specifies the parent ID of the asset. /ID (Mandatory) Specifies the unique ID of the asset object. /isCustomized (Mandatory) Specifies if the asset value has been customized. /marketSegmentId (Mandatory) Specifies the Market segment ID of the asset. { "status": "success", "httpStatusCode": 200, "opstatus": 0, "personalizedStrategy": [ { "recommendedWeight": "40", "targetWeight": "49.0", "Name": "en_IRS_Stock_TC01", "level": "1", "parentId": "2", "ID": "3", "isCustomized": "true", "marketSegmentId": "3015" }, { "recommendedWeight": "20", "targetWeight": "17.0", "Name": "en_IRS_FUNDS_TC01", "level": "1", "parentId": "2", "ID": "4", "isCustomized": "false", "marketSegmentId": "3017" }, { "recommendedWeight": "30", "targetWeight": "25.5", "Name": "en_IRS_BONDS_TC01", "level": "1", "parentId": "2", "ID": "5", "isCustomized": "false", "marketSegmentId": "3016" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "en_IRS_CASH_TC01", "level": "1", "parentId": "2", "ID": "6", "isCustomized": "false", "marketSegmentId": "3018" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "1", "parentId": "2", "ID": "7", "isCustomized": "false", "marketSegmentId": "3019" }, { "recommendedWeight": "30", "targetWeight": "36.75", "Name": "en_IRS_NA_TC01", "level": "2", "parentId": "3", "ID": "11", "isCustomized": "false", "marketSegmentId": "3023" }, { "recommendedWeight": "20", "targetWeight": "17.0", "Name": "en_IRS_NA_TC01", "level": "2", "parentId": "5", "ID": "12", "isCustomized": "false", "marketSegmentId": "3027" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "en_IRS_NA_TC01", "level": "2", "parentId": "4", "ID": "13", "isCustomized": "false", "marketSegmentId": "3031" }, { "recommendedWeight": "10", "targetWeight": "12.25", "Name": "IRS_EUROPE_TC01", "level": "2", "parentId": "3", "ID": "14", "isCustomized": "false", "marketSegmentId": "3022" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "en_IRS_EUROPE_TC01", "level": "2", "parentId": "5", "ID": "15", "isCustomized": "false", "marketSegmentId": "3026" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "en_IRS_EUROPE_TC01", "level": "2", "parentId": "4", "ID": "16", "isCustomized": "false", "marketSegmentId": "3030" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "2", "parentId": "3", "ID": "17", "isCustomized": "false", "marketSegmentId": "3021" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "2", "parentId": "5", "ID": "18", "isCustomized": "false", "marketSegmentId": "3025" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "2", "parentId": "4", "ID": "19", "isCustomized": "false", "marketSegmentId": "3029" }, { "recommendedWeight": "15", "targetWeight": "18.38", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "11", "ID": "26", "isCustomized": "false", "marketSegmentId": "3034" }, { "recommendedWeight": "7", "targetWeight": "8.57", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "14", "ID": "27", "isCustomized": "false", "marketSegmentId": "3038" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "12", "ID": "28", "isCustomized": "false", "marketSegmentId": "3042" }, { "recommendedWeight": "5", "targetWeight": "4.25", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "15", "ID": "29", "isCustomized": "false", "marketSegmentId": "3046" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "13", "ID": "30", "isCustomized": "false", "marketSegmentId": "3050" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_SECTOR_300_TC01", "level": "3", "parentId": "16", "ID": "31", "isCustomized": "false", "marketSegmentId": "3054" }, { "recommendedWeight": "15", "targetWeight": "18.38", "Name": "en_IRS_SECTOR_90_TC01", "level": "3", "parentId": "11", "ID": "32", "isCustomized": "false", "marketSegmentId": "3035" }, { "recommendedWeight": "3", "targetWeight": "3.68", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "14", "ID": "33", "isCustomized": "false", "marketSegmentId": "3039" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "12", "ID": "34", "isCustomized": "false", "marketSegmentId": "3043" }, { "recommendedWeight": "5", "targetWeight": "4.25", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "15", "ID": "35", "isCustomized": "false", "marketSegmentId": "3047" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "13", "ID": "36", "isCustomized": "false", "marketSegmentId": "3051" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "IRS_SECTOR_90_TC01", "level": "3", "parentId": "16", "ID": "37", "isCustomized": "false", "marketSegmentId": "3055" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "3", "parentId": "11", "ID": "38", "isCustomized": "false", "marketSegmentId": "3033" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "3", "parentId": "14", "ID": "39", "isCustomized": "false", "marketSegmentId": "3037" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "3", "parentId": "12", "ID": "40", "isCustomized": "false", "marketSegmentId": "3041" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "en_IRS_OTHERS_TC01", "level": "3", "parentId": "15", "ID": "41", "isCustomized": "false", "marketSegmentId": "3045" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "3", "parentId": "13", "ID": "42", "isCustomized": "false", "marketSegmentId": "3049" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "IRS_OTHERS_TC01", "level": "3", "parentId": "16", "ID": "43", "isCustomized": "false", "marketSegmentId": "3053" }, { "recommendedWeight": "15", "targetWeight": "18.38", "Name": "IS_MP_STNA300", "level": "4", "parentId": "26", "ID": "44", "isCustomized": "false" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "IS_MP_BONA300", "level": "4", "parentId": "28", "ID": "45", "isCustomized": "false" }, { "recommendedWeight": "10", "targetWeight": "8.5", "Name": "IS_MP_FUNA300", "level": "4", "parentId": "30", "ID": "46", "isCustomized": "false" }, { "recommendedWeight": "6", "targetWeight": "7.35", "Name": "DC STNA300 Amazon", "level": "4", "parentId": "26", "ID": "49", "isCustomized": "false" }, { "recommendedWeight": "4.5", "targetWeight": "5.51", "Name": "DC STNA300 Alphabet", "level": "4", "parentId": "26", "ID": "50", "isCustomized": "false" }, { "recommendedWeight": "4.5", "targetWeight": "5.51", "Name": "DC STNA300 Accenture", "level": "4", "parentId": "26", "ID": "51", "isCustomized": "false" }, { "recommendedWeight": "4", "targetWeight": "3.4", "Name": "DC BONA300 Basf", "level": "4", "parentId": "28", "ID": "52", "isCustomized": "false" }, { "recommendedWeight": "3", "targetWeight": "2.55", "Name": "DC BONA300 Citicorp", "level": "4", "parentId": "28", "ID": "53", "isCustomized": "false" }, { "recommendedWeight": "3", "targetWeight": "2.55", "Name": "DC BONA300 Daimler AG", "level": "4", "parentId": "28", "ID": "54", "isCustomized": "false" }, { "recommendedWeight": "4", "targetWeight": "3.4", "Name": "DC FUNA300 JPMC", "level": "4", "parentId": "30", "ID": "55", "isCustomized": "false" }, { "recommendedWeight": "3.5", "targetWeight": "2.98", "Name": "DC FUNA300 Scb Mutual Fund", "level": "4", "parentId": "30", "ID": "56", "isCustomized": "false" }, { "recommendedWeight": "2.5", "targetWeight": "2.13", "Name": "DC FUNA300 Uk Mutual Fund", "level": "4", "parentId": "30", "ID": "57", "isCustomized": "false" }, { "recommendedWeight": "0", "targetWeight": "0.0", "Name": "Current Account", "level": "2", "parentId": "6", "ID": "60", "isCustomized": "false" } ] } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: |
|
Enterprise API: |
/v1.0.0/holdings/portfolios/$portfolioId/checkStrategy |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Recommended Weight | recommendedWeight |
OriginalObjectiveWeight |
Target Weight | targetWeight | OBJECTIVE_WEIGHT |
Asset Name | Name | MKT_SEGMENT |
level | LEVEL_N | |
ParentId | PARENT_ID | |
marketSegmentId | ||
ID | ID | |
isCustomized | isCustomized |

Description: | This API rejects the investment proposal of a portfolio. |
Method: | POST |
URL: | {{baseURL}}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/rejectProposal |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. { "portfolioId": "190399-10", "portfolioDimensionE": "Portfolio", "sessionStatusE": "Rejected", "funcResultCode": "MANAGER00001915" } |
Response: |
Parameters /status (Mandatory) Specifies the success or the error status of the service. /message (Mandatory) Specifies the message. { "status": "success", "httpStatusCode": 200, "opstatus": 0, "message": "Update succeeded." } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: |
|
Enterprise API: |
/v1.0.0/order/orderSessions/$funcResultCode |
Field Mapping
No field Mappings for this API

Description: | This API retrieves the score of the portfolio questions. |
Method: | POST |
URL: | {{URL}}/services/data/v1/PortfolioServicing/operations/Strategies/submitStrategyQuestionnaire |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. percentN (Mandatory) Specifies the answered percentage. questionnaireDefCode (Mandatory) Specifies the questionnaire code. portfolioCode (Mandatory) Specifies the ID of the customer’s portfolio. statusE (Mandatory) Specifies the questionnaire status. ageCategory (Mandatory) Specifies the age of the customer. financialNeeds (Mandatory) Specifies the financial needs of customer. incomeExpectation (Mandatory) Specifies the income expectation of the customer. investmentKnowledge (Mandatory) Specifies the investment knowledge of customer. investmentPeriod (Mandatory) Specifies the investment period of customer. marketFallBehaviour (Mandatory) Specifies the market fall behaviour of the customer. investmentObjective (Mandatory) Specifies the investment objective of customer. { "portfolioId": "100777-4", "portfolioServiceType": "Advisory", "percentN": 40, "portfolioCode": "190493-1", "questionnaireDefCode": "PCK_DS_INVEST_PROF", "statusE": "To Validate", "ageCategory": "30_TO_BELOW_40", "description": "string", "financialNeeds": "VERY_EASILY", "generalDescription": "string", "incomeExpectation": "FALL", "investmentKnowledge": "LIMITED", "investmentObjective": "CAPITAL_PRESERVATION", "investmentPeriod": "10_YEARS_AND_ABOVE", "marketFallBehaviour": "ACCEPT_MINIMAL_DECLINES", "maxLossToleranceCapacity": "BETWEEN_20_AND_25", "page": 2, "percentCompletion": 100.00, "questionnaireHistoCode": "qu_PCK_DS_INVEST_PROF_20221021-00000002", "riskToleranceDescription": "Risk is an unavoidable part of investing. Historically, investments with higher return potential have required a higher tolerance for risk.Therefore, by clearly defining your risk tolerance, we will be better prepared to choose the most appropriate investments for your portfolio.", "timeHorizonDescription": "Your time horizon defines when you want to achieve a goal." } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /score (Mandatory) To determine user’s portfolio score. /opstatus (Mandatory) Segment opstatus is Mandatory. /httpStatusCode (Mandatory) Segment opstatus is Mandatory { "status": "success", "score": "28.0", "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/system/investmentProfileQuestionnaires |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
score | score |

Description: | This API retrieves used to update the recommended strategy to the portfolio. |
Method: | POST |
URL: | {{URL}}/services/data/v1/PortfolioServicing/operations/Strategies/confirmRcmdStrategy |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. strategyId (Mandatory) Specifies the strategy ID. strategyName (Mandatory) Specifies the strategy name. { "strategyId": "IRS_IP_ACTIVE", "strategyName": "active", "portfolioId": "190332-2", "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the success or the error status of the service. /httpStatusCode (Mandatory) Specifies the http status code. /opstatus (Mandatory) Specifies the opstatus. /ID (Mandatory) Determines the unique identifier. { "status": "success", "id": "17019", "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
opstatus |
|
|
status | ||
id | ||
httpstatuscode |

Description: | This API retrieves recommended and other strategy details. |
Method: | POST |
URL: | {{URL}}/services/data/v1/PortfolioServicing/operations/Strategies/getAllStrategies |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "190399-11", "portfolioServiceType": "Advisory", "strategyName": "Active" } |
Response: |
Parameters /status (Mandatory) Specifies the success or the error status of the service. /strategyId (Mandatory) Specifies the strategy id. /recStrategy (Mandatory) Specifies the JSON array that contains the recommended strategy details. /questionCode (Mandatory) Determines the question code for object. /alternateStrategy (Mandatory) Specifies the JSON array that contains the alternate strategy details. /strategyName (Mandatory) Description of the strategyName /assetCompo (Mandatory) Specifies the asset details. { "status": "success", "opstatus": 0, "httpStatusCode": 200, "recStrategy": [ { "strategyName": "Active", "strategyId": "IRS_IP_ACTIVE", "assetsCompo": [ { "assetName": "en_IRS_Stock_TC01", "weight": "40" }, { "assetName": "en_IRS_FUNDS_TC01", "weight": "20" }, { "assetName": "en_IRS_BONDS_TC01", "weight": "30" }, { "assetName": "en_IRS_CASH_TC01", "weight": "10" }, { "assetName": "en_IRS_OTHERS_TC01", "weight": "0" } ] } ], "alternateStrategy": [ { "strategyName": "Dynamic", "strategyId": "IRS_IP_DYNAMIC", "assetsCompo": [ { "assetName": "en_IRS_Stock_TC05", "weight": "45" }, { "assetName": "en_IRS_FUNDS_TC05", "weight": "10" }, { "assetName": "en_IRS_BONDS_TC05", "weight": "35" }, { "assetName": "en_IRS_CASH_TC05", "weight": "10" }, { "assetName": "en_IRS_OTHERS_TC05", "weight": "0" } ] }, { "strategyName": "Secure", "strategyId": "IRS_IP_SECURE", "assetsCompo": [ { "assetName": "en_IRS_Stock_TC03", "weight": "30" }, { "assetName": "en_IRS_FUNDS_TC03", "weight": "20" }, { "assetName": "en_IRS_BONDS_TC03", "weight": "30" }, { "assetName": "en_IRS_CASH_TC03", "weight": "20" }, { "assetName": "en_IRS_OTHERS_TC03", "weight": "0" } ] }, { "strategyName": "Conservative", "strategyId": "IRS_IP_CONSERVATIVE", "assetsCompo": [ { "assetName": "en_IRS_Stock_TC04", "weight": "20" }, { "assetName": "en_IRS_FUNDS_TC04", "weight": "30" }, { "assetName": "en_IRS_BONDS_TC04", "weight": "20" }, { "assetName": "en_IRS_CASH_TC04", "weight": "30" }, { "assetName": "en_IRS_OTHERS_TC04", "weight": "0" } ] }, { "strategyName": "Balanced", "strategyId": "IRS_IP_BALANCED", "assetsCompo": [ { "assetName": "en_IRS_Stock_TC02", "weight": "25" }, { "assetName": "en_IRS_FUNDS_TC02", "weight": "25" }, { "assetName": "en_IRS_BONDS_TC02", "weight": "25" }, { "assetName": "en_IRS_CASH_TC02", "weight": "25" }, { "assetName": "en_IRS_OTHERS_TC02", "weight": "0" } ] } ] } |
Error Code(s): |
Error Message: Unauthorized Access |
Enterprise Provider: |
Wealth FO |
Enterprise API: |
|
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Recommended strategy | strategyName |
proposedStrategyName |
StrategyID | ||
assetCompo | structureDenom valueN | |
Alternate strategies | strategyName | selectedStrategyCode_permValues |
StrategyID | ||
assetCompo | structureDenom valueN |

Description: | This API retreives the strategy for the portfolio. |
Method: | POST |
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/Strategies/getRcmdStrategy |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio portfolioServiceType (Mandatory) Specifies the Service Type of customer’s portfolio { "portfolioId": "190399-11" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /strategyId (Mandatory) Specifies the Unique ID of Strategy. /recStrategyName (Mandatory) Specifies the strategy name. /strategyList (Mandatory) Specifies the list of strategies. /strategyName (Mandatory) Specifies the strategy name depending on the value of risk level /minVal (Mandatory) Specifies the minimum value of that strategy. /maxVal (Mandatory) Specifies the maximum value of that strategy. /assets (Mandatory) Specifies the JSON Array containing the asset details. /assetName (Mandatory) Specifies the asset name. /weight (Mandatory) Specifies the weight of different assets. { "status": "success", "recStrategyName": "Active", "strategyId": "IRS_IP_ACTIVE", "recRiskLevel": "30", "strategyList": [ { "strategyName": "Secure", "minVal": "0", "maxVal": "14" }, { "strategyName": "Conservative", "minVal": "15", "maxVal": "17" }, { "strategyName": "Balanced", "minVal": "18", "maxVal": "24" }, { "strategyName": "Active", "minVal": "25", "maxVal": "32" }, { "strategyName": "Dynamic", "minVal": "33", "maxVal": "40" } ], "assets": [ { "assetName": "en_IRS_Stock_TC01", "weight": "40" }, { "assetName": "en_IRS_FUNDS_TC01", "weight": "20" }, { "assetName": "en_IRS_BONDS_TC01", "weight": "30" }, { "assetName": "en_IRS_CASH_TC01", "weight": "10" }, { "assetName": "en_IRS_OTHERS_TC01", "weight": "0" }, { "assetName": "IRS_IP_ACTIVE", "weight": "0" } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise ProvIDer: |
Wealth FO |
Enterprise API: |
|
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Asset Name | assetName | structureDenom |
Weight | Weight | valueN |
Strategy Name | recStrategyName | proposedStrategyName |

Description: | This API retrieves the validity of the current portfolio. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Strategies/getSuitabilityProfile |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "100777-5", "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the success or the error status of the service /expiryDate (Mandatory) Specifies the expiry date. /isValid (Mandatory) Specifies whether the isValid is success or not. /message (Mandatory) Specifies message based on the isValid. /opstatus (Mandatory) Segment opstatus is Mandatory. /httpStatusCode (Mandatory) Segment httpstatuscode is Mandatory. { "status": "success", "expiryDate": "10/09/2022", "isValid": "false", "message": "Current profile expired", "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise ProvIDer: | Wealth FO |
Enterprise API: |
v1.0.0/reference/strategies/investmentProfile/$portfolioId |
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Valid | message |
ext_ip_cur_status ext_ip_rvw_status |
Expiry | expiryDate | ext_ip_expiry_d |

Description: | This API retreives the asset allocation details of the portfolio. | ||
Method: | POST | ||
URL: | {{base_url}}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getAllocation | ||
Security Level: | Authenticated App User | ||
Header Request: |
|
||
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio { "portfolioId": "190404-1" } |
||
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /portfolioId (Mandatory) Specifies the portfolio ID. /asset (Mandatory) Specifies the JSON array of asset details. /region (Mandatory) Specifies the JSON array of region details. /currency (Mandatory) Specifies the JSON array of currency details. { "portfolioID": "190404-1", "asset": [ { "totalValue": "998327.87", "baseCurrency": "USD", "assetClass": "Liquidity", "valueByAssetClass": "698327.87", "weightByAssetClass": "69.95" }, { "totalValue": "998327.87", "baseCurrency": "USD", "assetClass": "Stocks", "valueByAssetClass": "300000.00", "weightByAssetClass": "30.05" } ], "currency": [ { "totalValue": "998327.87", "sectorCurrency": "USD", "baseCurrency": "USD", "weightByCurrency": "100.00", "valueByCurrency": "998327.87" } ], "region": [ { "totalValue": "998327.87", "region": "North America", "baseCurrency": "USD", "valueByRegion": "998327.87", "weightByRegion": "100.00" } ], "status": "success", "opstatus": 0, "httpStatusCode": 200 } } |
||
Error Code(s): | Error Message: Unauthorized Access | ||
Enterprise Provider: | Wealth FO | ||
Enterprise API: |
|
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Region Details | region | NA |
Currency Details | Currency | NA |
Asset Details | asset | NA |

Description: | This API retrieves the health details if the proposed orders are accepted. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/getPortfolioHealthIP |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioId (Mandatory) Specifies the ID of customer’s portfolio portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /Assets (Mandatory) Specifies the JSON Array containing the asset details. /currentWeight (Mandatory) Specifies the current weight by Region. /level (Mandatory) Specifies the level of the specific segment. /strategyWeight (Mandatory) Specifies the Strategy weight by Region. /parentId (Mandatory) Specifies the ID of the upper asset class. /ID (Mandatory) Specifies the Unique ID of the each asset name. /Name (Mandatory) Specifies the Name of the asset class. /healthStatus (Mandatory) Specifies the Status of health parameters. } { "status": "success", "portfolioID": "190332-5", "Assets": [{ "currentWeight": "43.45", "level": "2", "strategyWeight": "43.45", "parentId": "90", "ID": "139", "Name": "Current Account", "healthStatus": "0" }, { "currentWeight": "43.45", "level": "2", "strategyWeight": "43.45", "parentId": "48", "ID": "138", "Name": "Current Account", "healthStatus": "0" }, { "currentWeight": "43.45", "level": "2", "strategyWeight": "43.45", "parentId": "6", "ID": "137", "Name": "Current Account", "healthStatus": "0" }, { "currentWeight": "16.47", "level": "4", "strategyWeight": "16.47", "parentId": "74", "ID": "130", "Name": "DC STNA90 TC1019", "healthStatus": "0" }, { "currentWeight": "16.47", "level": "4", "strategyWeight": "16.47", "parentId": "32", "ID": "129", "Name": "DC STNA90 TC1019", "healthStatus": "0" }, { "currentWeight": "40.08", "level": "4", "strategyWeight": "40.08", "parentId": "68", "ID": "122", "Name": "DC STNA300 TC1019", "healthStatus": "0" }, { "currentWeight": "40.08", "level": "4", "strategyWeight": "40.08", "parentId": "26", "ID": "121", "Name": "DC STNA300 TC1019", "healthStatus": "0" }, { "currentWeight": "16.47", "level": "4", "strategyWeight": "16.47", "parentId": "109", "ID": "120", "Name": "DC STNA90 TC1019", "healthStatus": "0" }, { "currentWeight": "0", "level": "4", "strategyWeight": "0", "parentId": "78", "ID": "119", "Name": "INW FUNA90 TC224", "healthStatus": "1" }, { "currentWeight": "0", "level": "4", "strategyWeight": "0", "parentId": "32", "ID": "118", "Name": "INW STNA90 TC224", "healthStatus": "1" }, { "currentWeight": "16.47", "level": "4", "strategyWeight": "16.47", "parentId": "109", "ID": "117", "Name": "INW_MP_STNA90_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "4", "strategyWeight": "0", "parentId": "78", "ID": "116", "Name": "IRS_FUNA90_MP", "healthStatus": "0" }, { "currentWeight": "0", "level": "4", "strategyWeight": "0", "parentId": "32", "ID": "115", "Name": "IRS_STNA90_MP", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "97", "ID": "114", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "96", "ID": "113", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "95", "ID": "112", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "97", "ID": "111", "Name": "INW_SECTOR_90_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "96", "ID": "110", "Name": "INW_SECTOR_90_TC04", "healthStatus": "0" }, { "currentWeight": "16.47", "level": "3", "strategyWeight": "16.47", "parentId": "95", "ID": "109", "Name": "INW_SECTOR_90_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "97", "ID": "108", "Name": "INW_SECTOR_300_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "96", "ID": "107", "Name": "INW_SECTOR_300_TC04", "healthStatus": "1" }, { "currentWeight": "40.08", "level": "4", "strategyWeight": "40.08", "parentId": "104", "ID": "106", "Name": "DC STNA300 TC1019", "healthStatus": "0" }, { "currentWeight": "40.08", "level": "4", "strategyWeight": "40.08", "parentId": "104", "ID": "105", "Name": "INW_BUY_RL_TC04", "healthStatus": "0" }, { "currentWeight": "40.08", "level": "3", "strategyWeight": "40.08", "parentId": "95", "ID": "104", "Name": "INW_SECTOR_300_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "88", "ID": "100", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "89", "ID": "99", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "87", "ID": "98", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "88", "ID": "97", "Name": "INW_NA_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "89", "ID": "96", "Name": "INW_NA_TC04", "healthStatus": "1" }, { "currentWeight": "56.55", "level": "2", "strategyWeight": "56.55", "parentId": "87", "ID": "95", "Name": "INW_NA_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "86", "ID": "91", "Name": "INW_OTHERS_TC04", "healthStatus": "0" }, { "currentWeight": "43.45", "level": "1", "strategyWeight": "43.45", "parentId": "86", "ID": "90", "Name": "INW_CASH_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "86", "ID": "89", "Name": "INW_BONDS_TC04", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "86", "ID": "88", "Name": "INW_FUNDS_TC04", "healthStatus": "1" }, { "currentWeight": "56.55", "level": "1", "strategyWeight": "56.55", "parentId": "86", "ID": "87", "Name": "INW_Stock_TC04", "healthStatus": "1" }, { "currentWeight": "100", "level": "0", "strategyWeight": "100", "parentId": "1", "ID": "86", "Name": "INW_ALLOCATION_TC04", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "58", "ID": "85", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "55", "ID": "84", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "57", "ID": "83", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "54", "ID": "82", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "56", "ID": "81", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "53", "ID": "80", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "58", "ID": "79", "Name": "IRS_SECTOR_90_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "55", "ID": "78", "Name": "IRS_SECTOR_90_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "57", "ID": "77", "Name": "IRS_SECTOR_90_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "54", "ID": "76", "Name": "IRS_SECTOR_90_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "56", "ID": "75", "Name": "IRS_SECTOR_90_TC05", "healthStatus": "1" }, { "currentWeight": "16.47", "level": "3", "strategyWeight": "16.47", "parentId": "53", "ID": "74", "Name": "IRS_SECTOR_90_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "58", "ID": "73", "Name": "IRS_SECTOR_300_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "55", "ID": "72", "Name": "IRS_SECTOR_300_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "57", "ID": "71", "Name": "IRS_SECTOR_300_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "54", "ID": "70", "Name": "IRS_SECTOR_300_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "56", "ID": "69", "Name": "IRS_SECTOR_300_TC05", "healthStatus": "1" }, { "currentWeight": "40.08", "level": "3", "strategyWeight": "40.08", "parentId": "53", "ID": "68", "Name": "IRS_SECTOR_300_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "46", "ID": "61", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "47", "ID": "60", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "45", "ID": "59", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "46", "ID": "58", "Name": "IRS_EUROPE_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "47", "ID": "57", "Name": "IRS_EUROPE_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "45", "ID": "56", "Name": "IRS_EUROPE_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "46", "ID": "55", "Name": "IRS_NA_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "47", "ID": "54", "Name": "IRS_NA_TC05", "healthStatus": "1" }, { "currentWeight": "56.55", "level": "2", "strategyWeight": "56.55", "parentId": "45", "ID": "53", "Name": "IRS_NA_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "44", "ID": "49", "Name": "IRS_OTHERS_TC05", "healthStatus": "0" }, { "currentWeight": "43.45", "level": "1", "strategyWeight": "43.45", "parentId": "44", "ID": "48", "Name": "IRS_CASH_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "44", "ID": "47", "Name": "IRS_BONDS_TC05", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "44", "ID": "46", "Name": "IRS_FUNDS_TC05", "healthStatus": "1" }, { "currentWeight": "56.55", "level": "1", "strategyWeight": "56.55", "parentId": "44", "ID": "45", "Name": "IRS_Stock_TC05", "healthStatus": "1" }, { "currentWeight": "100", "level": "0", "strategyWeight": "100", "parentId": "1", "ID": "44", "Name": "IRS_ALC_DYNAMIC", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "16", "ID": "43", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "13", "ID": "42", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "15", "ID": "41", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "12", "ID": "40", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "14", "ID": "39", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "11", "ID": "38", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "16", "ID": "37", "Name": "IRS_SECTOR_90_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "13", "ID": "36", "Name": "IRS_SECTOR_90_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "15", "ID": "35", "Name": "IRS_SECTOR_90_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "12", "ID": "34", "Name": "IRS_SECTOR_90_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "14", "ID": "33", "Name": "IRS_SECTOR_90_TC01", "healthStatus": "0" }, { "currentWeight": "16.47", "level": "3", "strategyWeight": "16.47", "parentId": "11", "ID": "32", "Name": "IRS_SECTOR_90_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "16", "ID": "31", "Name": "IRS_SECTOR_300_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "13", "ID": "30", "Name": "IRS_SECTOR_300_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "15", "ID": "29", "Name": "IRS_SECTOR_300_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "12", "ID": "28", "Name": "IRS_SECTOR_300_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "3", "strategyWeight": "0", "parentId": "14", "ID": "27", "Name": "IRS_SECTOR_300_TC01", "healthStatus": "1" }, { "currentWeight": "40.08", "level": "3", "strategyWeight": "40.08", "parentId": "11", "ID": "26", "Name": "IRS_SECTOR_300_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "4", "ID": "19", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "5", "ID": "18", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "3", "ID": "17", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "4", "ID": "16", "Name": "IRS_EUROPE_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "5", "ID": "15", "Name": "IRS_EUROPE_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "3", "ID": "14", "Name": "IRS_EUROPE_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "4", "ID": "13", "Name": "IRS_NA_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "2", "strategyWeight": "0", "parentId": "5", "ID": "12", "Name": "IRS_NA_TC01", "healthStatus": "1" }, { "currentWeight": "56.55", "level": "2", "strategyWeight": "56.55", "parentId": "3", "ID": "11", "Name": "IRS_NA_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "2", "ID": "7", "Name": "IRS_OTHERS_TC01", "healthStatus": "0" }, { "currentWeight": "43.45", "level": "1", "strategyWeight": "43.45", "parentId": "2", "ID": "6", "Name": "IRS_CASH_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "2", "ID": "5", "Name": "IRS_BONDS_TC01", "healthStatus": "1" }, { "currentWeight": "0", "level": "1", "strategyWeight": "0", "parentId": "2", "ID": "4", "Name": "IRS_FUNDS_TC01", "healthStatus": "1" }, { "currentWeight": "56.55", "level": "1", "strategyWeight": "56.55", "parentId": "2", "ID": "3", "Name": "IRS_Stock_TC01", "healthStatus": "1" }, { "currentWeight": "100", "level": "0", "strategyWeight": "100", "parentId": "1", "ID": "2", "Name": "IRS_ALC_ACTIVE", "healthStatus": "0" }], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
/v1.0.0/order/orderSessions/$funcResultCode/complianceObjectives |
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Asset | currentWeight | OBJ_ACTUAL_WEIGHT |
strategyWeight | OBJ_EFFECTIVE_WEIGHT | |
Name | MKT_SEGMENT | |
healthStatus | OBJ_COMPLIANCE_INDICATOR |

Description: | This API retrieves the investment constraints for the portfolio health. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/PortfolioHealth/ getInvestmentConstraintsHC |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /portfolioId (Mandatory) Specifies the portfolio id. /investmentConstraintComment (Mandatory) Specifies the comment for the investment constraints /investmentConstraintStatus (Mandatory) Specifies the status parameter /investmentConstraintDetails (Mandatory) Specifies the details of the investment constraints. { "portfolioID": "100777-5", "investmentConstraintComment": "Some issues with your portfolio health", "investmentConstraintStatus": "1", "status": "success", "opstatus": 0, "httpStatusCode": 200, "investmentConstraintDetails": [{ "investmentConstraintDetails": "Sector concentration of 26.98% for Retail exceeds maximum recommended of 20% of the portfolio" }, { "investmentConstraintDetails": "Sector concentration of Recommended Instruments 20.06% for Computer Services exceeds maximum recommended of 15% of the portfolio" }] } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/holdings/portfolios/$portfolioId/constraintCheck |
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Status indicator | investmentConstraintStatus | AllConstraintComplianceE |
Investment details | investmentConstraintDetails | MODELL_CONSTR_FILTER ALLOC_CONSTR_FILTER SECU_IN_CONSTR_FILTER SECU_OUT_CONSTR_FILTER CONSTR_SET_FILTER |
Status message | investmentConstraintComment | MARKET_SEGMENT CONSTR_ACTUAL_POSITION MIN_OBJ MAX_OBJ |

Description: | This api retreives the strategy for the portfolio. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/getOrderProposal |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioId (Mandatory) Specifies the ID of customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. type (Mandatory) Specifies the Order Type of the portfolio. sortOrder (Mandatory) Specifies Sorting Order. pastProposalId (Mandatory) Specifies the Past proposal ID of customer’s portfolio. searchByInstrumentName (Mandatory) Specifies the Search Key value of the portfolio. sortBy (Mandatory) Specifies the Sorting filed of the portfolio. pageSize (Mandatory) Specifies the Size of the Page. pageOffset (Mandatory) Specifies the Number of Words within a Page. { "portfolioId": "190399-10", "portfolioServiceType": "Advisory", "type": "orderProposal", "sortBy": "currentWeight", "sortOrder": "desc", "searchByInstrumentName": "", "pageSize": "10", "pageOffset": "0", "pastProposalId": "", "funcResultCode": "" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /totalOrderAmount (Mandatory) Specifies the total Amount of a Order. /totalFeesTaxes (Mandatory) Specifies the total Taxof a Order. orderAmountCurrency (Mandatory) Specifies the Currency format of a Order. /proposaldateTime (Mandatory) Specifies the Order Proposed Date and Time. /totalCount (Mandatory) Specifies the total count of proposed Orders. /portfolioID (Mandatory) Specifies the Unique ID of the Portfolio. /orderProposal (Mandatory) Specifies the list of Orders. /instrumentName (Mandatory) Specifies the Instrument name of the order. /currentWeight (Mandatory) Specifies the Current Weight of the Order. /orderAmount (Mandatory) Specifies the Order amount. /investorDocuments (Mandatory) Specifies the Investor Documents of the Order. /isinExchange (Mandatory) Specifies the ISIN Exchange value of different Orders. /orderQty (Mandatory) Specifies the Quantity of the Order. /exchange (Mandatory) Specifies the Exchange value of different Orders. /targetWeight (Mandatory) Specifies Target weight of different Orders. /ISIN (Mandatory) Specifies the ISIN value of different Orders. /order (Mandatory) Specifies the type of the Order. { "status": "success", "totalOrderAmount": "-206560.0", "orderAmountCurrency": "USD", "totalCount": "2", "portfolioID": "190399-10", "orderProposal": [ { "instrumentName": "DC STNA90 TC1019", "orderAmount": "200000", "orderQty": "10000", "order": "Sell" }, { "instrumentName": "DC STNA90 TC1019", "orderAmount": "6560", "orderQty": "328", "order": "Sell" } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
Wealth FO |
Enterprise API: |
/v1.0.0/order/orderSessions/$funcResultCode/draftOrdersProposal |
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Order | order | ORDER_NATURE_TXT |
Instrument | instrumentName | INSTR_DENOM |
Current Weight | currentWeight | OBJ_ACTUAL_WEIGHT |
Target Weight | targetWeight | OBJ_EFFECTIVE_WEIGHT |
Order Quantity | orderQty | QUANTITY |
Order Amount | orderAmount | ORDER_PTF_AMOUNT |

Description: | This API retreives the past proposal for the Investment profile. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/getPastProposal |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioid (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service type of customer’s portfolio. type (Mandatory) Specifies the type filter (Mandatory) Specifies the time period. { "portfolioId": "190399-10", "type": "pastProposal", "portfolioServiceType": "Advisory", "contextId": "39082", "filter": "currentYear" } |
Response: |
Parameters /status (Mandatory) Specifies whether the service is success or not. /portfolioId (Mandatory) Specifies the portfolio id. /pastProposal (Mandatory) Specifies the JSON array of past proposals. /description (Mandatory) Specifies the description of past proposals. /dateTime (Mandatory) Specifies the date and time of past proposal. /header (Mandatory) Specifies the header of past proposals. /pastProposalId (Mandatory) Specifies the past proposal id { "status": "success", "funcResultCode": "", "isNewProp": "false", "pastProposal": [ { "description": "Proposal created on 06/03/2023 (10:35) for portfolio TESTPORTFOLIO", "dateTime": "17/03/2023,20:00 PM", "header": "Expired", "pastProposalId": "33027" }, { "description": "Proposal created on 06/03/2023 (10:34) for portfolio TESTPORTFOLIO", "dateTime": "06/03/2023,10:35 AM", "header": "Rejected", "pastProposalId": "33025" }, { "description": "Proposal created on 27/03/2023 (07:57) for portfolio TESTPORTFOLIO", "dateTime": "07/04/2023,20:00 PM", "header": "Expired", "pastProposalId": "45014" }, { "description": "Proposal created on 04/04/2023 (09:39) for portfolio TESTPORTFOLIO", "dateTime": "15/04/2023,20:00 PM", "header": "Expired", "pastProposalId": "53011" }, { "description": "Proposal created on 06/03/2023 (09:56) for portfolio TESTPORTFOLIO", "dateTime": "06/03/2023,09:56 AM", "header": "Released for Trading", "pastProposalId": "33021" } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
Wealth FO |
Enterprise API: |
/v1.0.0/order/orderSessions/listOfProposals |
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Details of past proposal | description | sessionDescriptionC |
Date and time of past proposal | dateTime | lastModifD |
Past proposal header | header | NA |
pastProposalId | NA |

Description: | This api retreives the health of the portfolio. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/PortfolioHealth/getPortfolioHealth |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioid (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service Type of customer’s portfolio. { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the whether the service is success or not. /portfolioHealth (Mandatory) Specifies the JSON Array containing the health parameters. /healthStatus (Mandatory) Specifies the status of health parameters. /healthParameter (Mandatory) Specifies the parameter of Portfolio. { "status": "success", "portfolioHealth": [{ "healthStatus": "0", "healthParameter": "Asset Allocation" }, { "healthStatus": "0", "healthParameter": "Risk Analysis" }, { "healthStatus": "0", "healthParameter": "Investment Constraints" }, { "healthStatus": "0", "healthParameter": "Recommended Instruments" }], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | WealthFO |
Enterprise API: |
|
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
Asset Allocation | healthStatus | NA |
Risk Analysis | healthStatus | NA |
Investment Constraints | healthStatus | NA |
Recommended Instruments | healthStatus | NA |
Names | healthParameter | NA |

Description: | This api retreives the risk details of the portfolio health. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/PortfolioHealth/getRiskAnalysisHC |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioid (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service Type of customer’s portfolio. { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the whether the service is success or not. riskAnalysis (Mandatory) Specifies the JSON Array containing the risk details. riskStatus (Mandatory) Specifies the status of risk. riskPortfolioMeasureP (Mandatory) Specifies the parameter of risk portfolio. riskStratMeasureP (Mandatory) Specifies the parameter of strategy risk. riskToleranceMinP (Mandatory) Specifies the parameter of risk tolerance min value. riskToleranceMaxP (Mandatory) Specifies the parameter of risk tolerance max value. { "portfolioID": "190332-5", "status": "success", "riskAnalysis": [{ "riskStatus": "0", "riskPortMeasureP": "0", "riskStratMeasureP": "0", "riskToleranceMinP": "200", "riskToleranceMaxP": "700", "riskObjectiveP": "500" }] "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
riskAnalysis | NA | |
Risk Indicator | riskStatus | MainRiskComplianceE |
Portfolio Risk | riskPortMeasureP | mainRiskPortfolioMeasureP |
Investment profile risk | riskStratMeasureP | mainRiskStratMeasureP |
Tolerance range | riskToleranceMinP | mainRiskMinP |
Tolerance range | riskToleranceMaxP | mainRiskMaxP |
Risk Objective | riskObjectiveP | mainRiskObjectiveP |

Description: | This api retreives the risk details of the portfolio health. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/getRiskAnalysisIP |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the service Type of customer’s portfolio. { "portfolioId": "100777-4" "portfolioServiceType": "Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the whether the service is success or not. riskAnalysis (Mandatory) Specifies the JSON Array containing the risk details. riskStatus (Mandatory) Specifies the status of risk. riskPortfolioMeasureP (Mandatory) Specifies the parameter of risk portfolio. riskStratMeasureP (Mandatory) Specifies the parameter of strategy risk. riskToleranceMinP (Mandatory) Specifies the parameter of risk tolerance min value. riskToleranceMaxP (Mandatory) Specifies the parameter of risk tolerance max value. { "portfolioID": "190332-5", "status": "success", "riskAnalysis": [{ "riskStatus": "0", "riskPortMeasureP": "0", "riskStratMeasureP": "0", "riskToleranceMinP": "200", "riskToleranceMaxP": "700", "riskObjectiveP": "500" }] "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
UI field | Experience API field | Wealth FO API field |
---|---|---|
riskAnalysis | NA | |
Risk Indicator | riskStatus | MainRiskComplianceE |
Portfolio Risk | riskPortMeasureP | mainRiskPortfolioMeasureP |
Investment profile risk | riskStratMeasureP | mainRiskStratMeasureP |
Tolerance range | riskToleranceMinP | mainRiskMinP |
Tolerance range | riskToleranceMaxP | mainRiskMaxP |
Risk Objective | riskObjectiveP | mainRiskObjectiveP |

Description: | This API is used to revert the personalized changes. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Strategies/revertStrategy |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the portfolio service Type. { "portfolioId": "190332-6", "portfolioServiceType":"Advisory" } |
Response: |
Parameters /status (Mandatory) Specifies the whether the service is success or not. message (Mandatory) Specifies the success message. { "message": "Delete succeeded", "status": "success", "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/reference/strategies/modelConstraintElements/$constraintId |
Field Mapping
No field mapping for this API

Description: | This API is used to confirm the orders of portfolio in the Investment Proposal screen. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/confirmOrdersIP |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID of the customer’s portfolio. funResultCode (Mandatory) Specifies the result code of the function. { "portfolioId": "190332-7", "funcResultCode" : "MANAGER00000770" } |
Response: |
Parameters message (Mandatory) Specifies the order placed successfully. { "message": "Orders placed successfully.", "opstatus": 20013, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
No field mapping for this API

Description: | This API retrieves the constraints details for the Investment proposal. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/InvestmentProposal/getConstraintsIP |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the portfolio service type. { "portfolioId": "190404-1", "portfolioServiceType": "Advisory" } |
Response: |
Parameters status (Mandatory) Specifies the whether the service is success or not. constraintDetails (Mandatory) Specifies the investment constraint details of Advisory Portfolio. { "status": "success", "constraintDetails": [ { "investmentConstraintDetails": "Market Segment TEST_SECTOR300 has a current weight of 0 having constraint of minimum 0% and maximum 100%." }, { "investmentConstraintDetails": "Instrument DC BONA300 TC1020 has a current value of 0% having constraint of minimum 0% and maximum 100%." } ], "opstatus": 0, "httpStatusCode": 200 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/holdings/portfolios/$portfolioId/constraintCheck |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Status indicator | investmentConstraintStatus |
AllConstraintComplianceE |
Investment details | investmentConstraintDetails | MODELL_CONSTR_FILTER ALLOC_CONSTR_FILTER SECU_IN_CONSTR_FILTER SECU_OUT_CONSTR_FILTER CONSTR_SET_FILTER |
Status message | investmentConstraintComment | MARKET_SEGMENT CONSTR_ACTUAL_POSITION MIN_OBJ MAX_OBJ |

Description: | This API is used to select strategy after answering the questionnaire. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Reports/generatePastProposalPDF |
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. portfolioServiceType (Mandatory) Specifies the portfolio service type. { "portfolioId": "100777-5", "portfolioServiceType": "Advisory", "navPage": "pastProposal" } |
Response: |
Parameters base (Mandatory) Specifies the base 64 value { "status": "success", "opstatus": 0, "httpStatusCode": 200, } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
|
Field Mapping
No field mappings for this API.

Description: | This API used to confirm the user selected strategy. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Strategies/confirmChangeStrategyire |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio. portfolioServiceType (Mandatory) Specifies the portfolio service type. strategyID (Mandatory) Specifies the strategy ID. strategyName (Mandatory) Specifies the strategy name of the respective portfolio. { "strategyId": "102", "strategyName": "Conservative", "portfolioId": "100777-4", "portfolioServiceType": "Advisory" } |
Response: |
Parameters id (Mandatory) Specifies the strategy id created on success of changing strategy { "status": "success", "id": "STRATEGY26810", "opstatus": 0, "httpStatusCode": 200, } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: | Wealth FO |
Enterprise API: |
v1.0.0/reference/strategies/portfolioStrategyLinks |
Field Mapping
No field mappings for this API.

Description: | This API retrieves the pdf base64 value for past proposal data. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Reports/generatePastProposalP |
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 downloads the field names. portfolioServiceType (Mandatory) Specifies the portfolio service type. { "portfolioId": "100777-5", "portfolioServiceType": "Advisory", "navPage": "pastProposal" } |
Response: |
Parameters base (Mandatory) Specifies the base 64 value. click here to view the response code |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
|
Enterprise API: |
NA |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field | Transact Field |
---|---|---|---|
base | NA | NA |

Description: | This API retrieves the data for the portfolio graph. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getInstrumentTotal |
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 downloads the field names. graphDuration (Mandatory) Specifies the graph duration. { "portfolioId": "100777-1", "navPage": "Portfolio", "graphDuration": "OneM" } |
Response: |
![]() 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 /graphDuration (Mandatory) Specifies the graphDuration /marketValue (Mandatory) Specifies the total value of the portfolio holdings /todayPLAmount (Mandatory) Specifies the todayPLAmount /accountNumber (Mandatory) Specifies the accountNumber /unRealizedPLPercentage (Mandatory) Specifies the unRealized PL Percentage /unRealizedPLAmount (Mandatory) Specifies the unRealized PL Amount /todayPL (Mandatory) Specifies the todayPL value /todayPLPercentage (Mandatory) Specifies the todayPLPercentage value /unRealizedPL (Mandatory) Specifies the unRealizedPL value /AMOUNT (Mandatory) Specifies the amount on graph value /TIMESTAMP (Mandatory) Specifies the time range /PERCENTAGE (Mandatory) Specifies the percentage { { "instrumentTotal": [ { "unRealizedPL": "P", "OneM": [ { "AMOUNT": "47600.12", "TIMESTAMP": "2023-11-19T13:57:56+05:30", "PERCENTAGE": "0.25" }, { "AMOUNT": "48400.22", "TIMESTAMP": "2023-11-20T13:57:56+05:30", "PERCENTAGE": "1.25" }, { "AMOUNT": "47500.82", "TIMESTAMP": "2023-11-21T13:57:56+05:30", "PERCENTAGE": "2.25" }, { "AMOUNT": "48800.33", "TIMESTAMP": "2023-11-22T13:57:56+05:30", "PERCENTAGE": "3.25" }, { "AMOUNT": "49200.22", "TIMESTAMP": "2023-11-23T13:57:56+05:30", "PERCENTAGE": "4.25" }, { "AMOUNT": "49000.65", "TIMESTAMP": "2023-11-24T13:57:56+05:30", "PERCENTAGE": "5.25" }, { "AMOUNT": "48700.22", "TIMESTAMP": "2023-11-25T13:57:56+05:30", "PERCENTAGE": "6.25" }, { "AMOUNT": "47800.12", "TIMESTAMP": "2023-11-26T13:57:56+05:30", "PERCENTAGE": "7.25" }, { "AMOUNT": "48700.33", "TIMESTAMP": "2023-11-27T13:57:56+05:30", "PERCENTAGE": "8.25" }, { "AMOUNT": "49000.01", "TIMESTAMP": "2023-11-28T13:57:56+05:30", "PERCENTAGE": "9.25" }, { "AMOUNT": "49000.88", "TIMESTAMP": "2023-11-29T13:57:56+05:30", "PERCENTAGE": "10.25" }, { "AMOUNT": "47600.68", "TIMESTAMP": "2023-11-30T13:57:56+05:30", "PERCENTAGE": "11.25" }, { "AMOUNT": "47800.72", "TIMESTAMP": "2023-12-01T13:57:56+05:30", "PERCENTAGE": "12.25" }, { "AMOUNT": "48200.33", "TIMESTAMP": "2023-12-02T13:57:56+05:30", "PERCENTAGE": "13.25" }, { "AMOUNT": "47600.12", "TIMESTAMP": "2023-12-03T13:57:56+05:30", "PERCENTAGE": "14.25" }, { "AMOUNT": "48200.43", "TIMESTAMP": "2023-12-04T13:57:56+05:30", "PERCENTAGE": "15.25" }, { "AMOUNT": "48700.77", "TIMESTAMP": "2023-12-05T13:57:56+05:30", "PERCENTAGE": "16.25" }, { "AMOUNT": "48000.2", "TIMESTAMP": "2023-12-06T13:57:56+05:30", "PERCENTAGE": "17.25" }, { "AMOUNT": "49900.33", "TIMESTAMP": "2023-12-07T13:57:56+05:30", "PERCENTAGE": "18.25" }, { "AMOUNT": "47700.0", "TIMESTAMP": "2023-12-08T13:57:56+05:30", "PERCENTAGE": "19.25" }, { "AMOUNT": "47200.0", "TIMESTAMP": "2023-12-09T13:57:56+05:30", "PERCENTAGE": "20.25" }, { "AMOUNT": "47200.5", "TIMESTAMP": "2023-12-10T13:57:56+05:30", "PERCENTAGE": "21.25" }, { "AMOUNT": "47700.3", "TIMESTAMP": "2023-12-11T13:57:56+05:30", "PERCENTAGE": "22.25" }, { "AMOUNT": "47800.0", "TIMESTAMP": "2023-12-12T13:57:56+05:30", "PERCENTAGE": "23.25" }, { "AMOUNT": "48500.0", "TIMESTAMP": "2023-12-13T13:57:56+05:30", "PERCENTAGE": "24.25" }, { "AMOUNT": "47200.0", "TIMESTAMP": "2023-12-14T13:57:56+05:30", "PERCENTAGE": "25.25" }, { "AMOUNT": "48200.11", "TIMESTAMP": "2023-12-15T13:57:56+05:30", "PERCENTAGE": "26.25" }, { "AMOUNT": "47700.12", "TIMESTAMP": "2023-12-16T13:57:56+05:30", "PERCENTAGE": "27.25" }, { "AMOUNT": "49500.23", "TIMESTAMP": "2023-12-17T13:57:56+05:30", "PERCENTAGE": "28.25" }, { "AMOUNT": "48700.3", "TIMESTAMP": "2023-12-18T13:57:56+05:30", "PERCENTAGE": "29.25" } ], "referenceCurrency": "USD", "accountName": "John Bailey Portfolio 1.", "marketValue": "49572.43", "graphDuration": "OneM", "todayPLAmount": "510.12", "accountNumber": "100777-1", "unRealizedPLPercentage": "11.33", "unRealizedPLAmount": "5023.50", "portfolioID": "100777-1", "todayPL": "P", "opstatus": "0", "todayPLPercentage": "1.15", "httpStatusCode": "200" } ], "opstatus": 0, "opstatus_getInstrumentTotalMock": 0, "httpStatusCode": 0 } ![]() 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 /graphDuration (Mandatory) Specifies the graphDuration /marketValue (Mandatory) Specifies the total value of the portfolio holdings /todayPLAmount (Mandatory) Specifies the todayPLAmount /accountNumber (Mandatory) Specifies the accountNumber /unRealizedPLPercentage (Mandatory) Specifies the unRealized PL Percentage /unRealizedPLAmount (Mandatory) Specifies the unRealized PL Amount /todayPL (Mandatory) Specifies the todayPL value /todayPLPercentage (Mandatory) Specifies the todayPLPercentage value /unRealizedPL (Mandatory) Specifies the unRealizedPL value { "instrumentTotal": [ { "unRealizedPL": "P", "OneM": [], "referenceCurrency": "USD", "accountName": "TestPortfolio", "marketValue": "989850", "graphDuration": "OneM", "todayPLAmount": "", "accountNumber": "190492-1", "unRealizedPLPercentage": "0.00", "unRealizedPLAmount": "0", "portfolioID": "190492-1", "todayPL": "", "opstatus": "0", "todayPLPercentage": "", "httpStatusCode": "200", "status": "success" } ], "opstatus": 0, "opstatus_getInstrumentTotal": 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 Field |
---|---|---|---|
ISIN (Value only displayed in UI) | ISIN | PORTFOLIO_CODE | portfolioId |
Portfolio Account Name(Value only displayed in UI) | AccountName | PORTFOLIO_NAME | portfolioName |
Currency Symbol (Value only displayed in UI) | ReferenceCurrency | REF_CURRENCY | referenceCurrency |
Percentage in Portfolio Graph | Percentage | DIFF_PERF | |
Unrealized PL (Value only displayed in UI) | unRealizedPLAmount | PERIOD_GAIN_LOSS | unrealProfitLoss |
Market Price in Portfolio Graph | Amount | PERIOD_FINAL_MKT_VAL | |
Market Price in Portfolio Graph | Amount | PERIOD_INITIAL_MKT_VAL | |
TimeStamp in Portfolio Graph | TimeStamp | PERIOD_INITIAL_DATE | |
TimeStamp in Portfolio Graph | TimeStamp | PERIOD_FINAL_DATE | |
Unrealized PL % (Value only displayed in UI) | unRealizedPLPercentage | unrealisedProfitLossPercentage |

Description: | This API retrieves the data portfolio orders. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/PortfolioDetails/getOrderDetails |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters portfolioID (Mandatory) Specifies the ID field of the customer’s portfolio. sortBy (Mandatory) Specifies the field on which the sort needs to be performed. navPage (Mandatory) This parameter downloads 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: |
![]() 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 /isinExchange (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 placed order 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 { "portfolioID": "190345-1", "endDate": "", "sortOrder": "DESC", "sortBy": "tradeDate", "totalCount": "1", "startDate": "", "status": "success", "ordersDetails": [ { "orderType": "Sell Market", "quantity": "8348", "limitPrice": "", "isTapIntegration": "true", "instrumentId": "100027-000", "isinExchange": "NEW YORK", "description": "Google LLC", "tradeDate": "2023-11-21", "ISIN": "", "assetType": "Stock", "orderedAt": "21/11/2023 12:46:22", "stopPrice": "", "orderMode": "Sell", "orderModeType": "Market", "isModifyEnable": "true", "isCancelEnable": "true", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "D1903451020", "validity": "Good Till Canceled", "uniqueid": "0", "holdingsType": "NEW YORK", "orderExecutionPrice": "", "status": "Open" } ], "opstatus": 0, "httpStatusCode": 200 } ![]() 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 /isinExchange (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 /swipeActionEnable (Mandatory) Specifies whether swipe 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 { "portfolioID": "190492-1", "endDate": "", "sortOrder": "DESC", "sortBy": "tradeDate", "totalCount": "7", "startDate": "", "status": "success", "ordersDetails": [ { "orderType": "Buy Stop Limit", "quantity": "100", "limitPrice": "22", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:16", "stopPrice": "21", "orderMode": "Buy", "orderModeType": "Stop Limit", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310820767", "validity": "Good Till Canceled", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY PURCHASE" }, { "orderType": "Sell Stop Limit", "quantity": "100", "limitPrice": "21", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:29", "stopPrice": "22", "orderMode": "Sell", "orderModeType": "Stop Limit", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310834001", "validity": "Day Order", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY SALE" }, { "orderType": "Sell Stop Loss", "quantity": "100", "limitPrice": "", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:27", "stopPrice": "21", "orderMode": "Sell", "orderModeType": "Stop Loss", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310894999", "validity": "Day Order", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY SALE" }, { "orderType": "Sell Limit", "quantity": "100", "limitPrice": "21", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:25", "stopPrice": "", "orderMode": "Sell", "orderModeType": "Limit", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310820096", "validity": "Day Order", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY SALE" }, { "orderType": "Sell Market", "quantity": "100", "limitPrice": "", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:23", "stopPrice": "", "orderMode": "Sell", "orderModeType": "Market", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310837100", "validity": "Day Order", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY SALE" }, { "orderType": "Buy Stop Limit", "quantity": "100", "limitPrice": "22", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:21", "stopPrice": "21", "orderMode": "Buy", "orderModeType": "Stop Limit", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310830086", "validity": "Day Order", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY PURCHASE" }, { "orderType": "Buy Market", "quantity": "100", "limitPrice": "", "instrumentId": "190492-101", "isinExchange": "NYSE", "description": "HARMAN STOCK FUNDS MF TC60", "tradeDate": "2023-12-08", "ISIN": "", "orderedAt": "09:48:13", "stopPrice": "", "orderMode": "Buy", "orderModeType": "Market", "swipeActionEnable": "true", "instrumentCurrency": "USD", "orderReference": "OPODSC2310883467", "validity": "Day Order", "holdingsType": "NYSE", "orderExecutionPrice": "", "status": "Open", "transactionName": "SECURITY PURCHASE" } ], "opstatus": 0, "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 Field |
---|---|---|---|
Type | orderType | Order_Nature, Limit_Nature | TransactionType, OrderType |
Quantity | quantity | Quantity | Quantity |
Limit Price | limitPrice | 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 |

Description: | This API retrieves the portfolio list data and asset list data. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Dashboard/getWealthDashboard |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
NA |
Response: |
![]() 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 /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 { "opstatus_getPortfolioList": 0, "isTapIntegration": "true", "opstatus_getAssetList": 0, "opstatus": 0, "AssetList": { "unRealizedPLAmount": "-305340.0", "unRealizedPL": "L", "referenceCurrency": "USD", "assets": [ { "assetGroup": "Liquidity", "marketValue": "-143967.36" }, { "assetGroup": "Others", "marketValue": "23438" }, { "assetGroup": "Stocks", "marketValue": "15000" }, { "assetGroup": "Fixed Income", "marketValue": "185.02" } ], "customerId": "190800", "totalAssetValue": "-105344.34", "unRealizedPLPercentage": "" }, "PortfolioList": { "portfolioList": [ { "unRealizedPL": "L", "referenceCurrency": "USD", "portfolioManagedSince": "2023-04-18", "accountName": "My Discretionary Portfolio 1", "marketValue": "-205344.34", "PortfolioMVCustCurr": "-205344.34", "accountNumber": "190800-1", "unRealizedPLPercentage": "", "jointHolders": "", "unRealizedPLAmount": "305340.0", "portfolioId": "190800-1", "customerId": "190800", "portfolioCCY": "USD", "investmentType": "Discretionary", "jointHolderId": "", "primaryHolder": "JAMES", "portfolioCode": "9002", "statusE": "<None>", "isJointAccount": "false" }, { "unRealizedPL": "P", "referenceCurrency": "USD", "portfolioManagedSince": "2023-04-18", "accountName": "My Advisory Portfolio 2", "marketValue": "100000", "PortfolioMVCustCurr": "100000", "accountNumber": "190800-2", "unRealizedPLPercentage": "", "jointHolders": "", "unRealizedPLAmount": "0.0", "portfolioId": "190800-2", "customerId": "190800", "portfolioCCY": "USD", "investmentType": "Advisory", "jointHolderId": "", "primaryHolder": "JAMES", "portfolioCode": "11001", "statusE": "<None>", "isJointAccount": "false" } ] }, "httpStatusCode": 200, "status": "success" } ![]() 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 /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_getTransactAssetList": 0, "opstatus_getPortfolioList": 0, "opstatus_getAssetList": 0, "opstatus": 0, "PortfolioList": { "portfolioList": [ { "unRealizedPL": "P", "referenceCurrency": "USD", "accountName": "TestPortfolio", "marketValue": "989850", "accountNumber": "190492-1", "unRealizedPLPercentage": "0.00", "jointHolders": "", "unRealizedPLAmount": "0.00", "portfolioId": "190492-1", "customerId": "190492", "investmentType": "Balanced Model", "portfolioCCY": "USD", "jointHolderId": "", "primaryHolder": "ChrisTC60", "isJointAccount": "false" } ] }, "httpStatusCode": "200" } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
|
Enterprise API: |
Wealth FO:
Transact:
|
Field Mapping
UI Field | Experience API Field | Wealth FO API Field | Transact 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 |
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 | |
Market Price (Value only displayed in UI ) | TotalAssetValue | MVPortfolio | |
NA | CustomerID | ||
Unrealized P&L (Value only displayed in UI ) | unRealizedPLAmount | Total_PL |

Description: | This API retrieves the list of customers and their asset values. |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Customer/getCustomers |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters /coreCustomerId (Mandatory) Specifies the ID field of the core customer { "coreCustomerId": "190429,190430" } |
Response: |
Parameters /isWealthUser (Mandatory) Specifies whether the user is wealth or not /isMultiCustomer (Mandatory) Specifies whether it is multicustomer or not /customerId (Mandatory) Specifies the customer ID. /isFavourite (Mandatory) Specifies whether customer is favourite or not /customerName (Mandatory) Specifies the customer name /currencyCode (Mandatory) Specifies the currency code /totalAssetValue (Mandatory) Specifies the total asset value { "isWealthUser": "true", "isMultiCustomer": "true", "httpStatusCode": 200, "opstatus": 0, "Customers": [ { "customerId": "190410", "isFavourite": "true", "customerName": "David Jones", "totalAssetValue": "1110000", "currencyCode": "USD" }, { "customerId": "190412", "isFavourite": "true", "customerName": "Thomas Linkinson", "totalAssetValue": "", "currencyCode": "USD" }, { "customerId": "190411", "isFavourite": "true", "customerName": "Charles Winkinson", "totalAssetValue": "10000", "currencyCode": "USD" } ] } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
Wealth FO |
Enterprise API: |
Wealth FO: v1.0.0/party/customers?codeIncludes=$coreCustomerId1, $coreCustomerId2 |
Field Mapping
UI Field | Experience API Field | Wealth FO API Field |
---|---|---|
Customer | customerId | code |
NA | isFavourite | |
Customer | customerName | name |
Market Value | currencyCode | currencyCode |
Region | totalAssetValue | extTdMktValM |

Description: | This API is used to add or remove customer from favorites |
Method: | POST |
URL: | {base_url}/services/data/v1/PortfolioServicing/operations/Customer/updateFavoriteCustomer |
Security Level: | Authenticated App User |
Header Request: |
|
Body Request: |
Parameters /operation (Mandatory) Specifies the operation (Add/Remove) /backendId (Mandatory) Specifies the customer id which needs to added/removed from favorites { "operation": "Add", "backendId":"191025" } |
Response: |
Parameters /msg (Mandatory) Specifies the success message { "status": "Success", "msg": "Favourite customers updated successfully", "httpStatusCode": "200", "opstatus": 0 } |
Error Code(s): | Error Message: Unauthorized Access |
Enterprise Provider: |
NA |
Enterprise API: |
NA |
Field Mapping
No Field Mappings


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. |

Parameter Name | DataType | Description |
---|---|---|
portfolioID | string | Specifies the ID of the customers portfolio. |
navPage | string | This parameter is used to set the field names and retrieve the response from the respected services. |
sortBy | string | Specifies the field on which the sort needs to be performed. |
searchByInstrumentName | string | Specifies the value on which the search needs to be performed. |
startDate | string | Specifies the date from when the records are to be retrieved for the customer. |
endDate | string | Specifies the date until when the records are to be retrieved for the customer. |
accountID | string | Specifies the account ID of the customer (for account activity report). |
dateFrom | string | Specifies the date from when the records are to be retrieved for the customer. |
dateTo | string | Specifies the date until when the records are to be retrieved for the customer. |
listType | string | Specifies the type of list to be fetched. |
currencyID | string | Specifies the reference currency of the customer. |
benchMarkIndex | String | Specifies the market indices created by using multiple instruments of the market/sector. |
duration | String | Specifies the time period. |
type | String | Specifies the type of orders to be fetched. |
orderID | String | Specifies the order reference ID of the order. |
isEuro | String | Specifies whether the currency is euro. |
instrumentID | String | Specifies the ID of the instrument. |
sortOrder | String | Specifies the order used for sorting such as ascending or descending. |

Parameter Name | DataType | Description |
---|---|---|
ID | String | Specifies the ID of the instrument. |
userID | String | Specifies the user ID of the customer. |
customerID | String | Specifies the customer ID. |
favInstrumentCodes | String | Specifies the Favorite instruments RICCode. |
RICCode | String | Specifies the RICCode. |
operation | String | Specifies the operation (add/remove/update). |
favInstrumentIDs | String | Specifies the comma seperated instrument IDs. |
instrumentID | String | Specifies the ID of instrument. |

Parameter Name | DataType | Description |
---|---|---|
portfolioID | String | Specifies the portfolio ID of the customer. |
portfolioName | String | Specifies the portfolio name of the customer. |
referenceCurrency | String | Specifies the reference currency of the portfolio. |
marketValue | String | Specifies the market value of the portfolio in the portfolio reference currency. |
unRealizedPL | String | Specifies the unrealized PL. |
unRealizedPLAmount | String | Specifies the unrealized PL of the portfolio in the portfolio reference currency. |
unRealizedPLPercentage | String | Specifies the unrealized PL percentage change of the portfolio. |
todayPL | String | Specifies the today PL. |
todayPLAmount | String | Specifies the today PL of the portfolio in the portfolio reference currency. |
todayPLPercentage | String | Specifies the today PL percentage of the portfolio. |
assetGroup | String | Specifies the asset type of the instrument. |
graphDuration | String | Specifies the duration for which the graph to be displayed. |
navPage | String | Specifies the page from which service is being called. |
totalCashBalance | String | Specifies the total cash balance of the portfolio in portfolio reference currency. |
currency | String | Specifies the currency of the account linked to the portfolio. |
balance | String | Specifies the account balance in the account currency. |
accountName | String | Specifies the account name. |
totalCashBalanceCurrency | String | Specifies the total cash balance in the portfolio reference currency. |
totalMarketValue | String | Specifies the total market value in the portfolio reference currency. |
TIMESTAMP | String | Specifies the date and time for instrument graph. |
AMOUNT | String | Specifies the instrument price for instrument graph. |
PERCENTAGE | String | Specifies the percentage change for instrument graph. |
currencyName | String | Specifies the currency. |
accountNumber | String | Specifies the account number of the account linked to the portfolio. |
investmentType | String | Specifies the investment type. |
customerID | String | Specifies the customer ID of the customer. |
referenceCurrencyValue | String | Specifies the value in reference currency. |
ricCodes | String | Specifies the RICCODE of the instrument which is used to get data from Refinitiv. |
searchByInstrumentName | String | Specifies the value on which the search needs to be performed. |
sortBy | String | Specifies the field on which the sort needs to be performed. |
sortOrder | String | Specifies the order used for sorting such as ascending or descending. |
pageSize | String | Specifies the number of records to be returned. |
pageOffset | String | Specifies the index of the starting record. |
userID | String | Specifies the user ID. |
totalCount | String | Specifies the total count. |

Parameter Name | DataType | Description |
---|---|---|
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. |

Parameter Name | DataType | Description |
---|---|---|
portfolioID | String | Specifies the portfolio ID of the customer. |
searchByInstrumentName | String | Specifies the value on which the search needs to be performed. |
type | String | Specifies the type of order. |
startDate | String | Specifies the date from when the records are to be retrieved for the customer. |
endDate | String | Specifies the date until when the records are to be retrieved for the customer. |
sortBy | String | Specifies the field on which the sort needs to be performed. |
orderID | String | Specifies the Transact/Wealth FO Order ID of the order placed. |
sortOrder | String | Specifies the order used for sorting such as ascending or descending. |
pageSize | String | Specifies the number of records to be returned. |
pageOffset | String | Specifies the index of the starting record. |
instrumentID | String | Specifies the instrument ID. |
assetType | String | Specifies the asset type of the instrument. |

Parameter Name | DataType | Description |
---|---|---|
portfolioID | String | Specifies the portfolio ID of the customer. |
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. |

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. |

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