-- User Story -- Sequence Diagram -- Ingest Assets Classes -- Regions and Countries -- Transaction Categories -- Corporate action types -- Ingestion Dummy Corporate Action -- Instruments & Prices & Exchange -- Pull Request
https://backbase.atlassian.net/browse/MWM-35
Ingesting the following assets classes
| Asset class | Asset Code | **Description ** |
|---|---|---|
| Equity | equity | A "Equity" class the represents the type of available securities supported by DW |
| Cash | cash | A "cash" class represents the full amount for securities purchased using their own funds. |
| Other | other | Others |
Stream Wealth Bundle Example
{ "assetClasses": [ { "assetClass": { "name": "Equity", "code": "1" }, "subAssetClasses": [ { "name": "Equity", "code": "equity" }, { "name": "ETF", "code": "etf" }, { "name": "ADR", "code": "adr" } ] }, { "assetClass": { "name": "Cash", "code": "3" }, "subAssetClasses": [ { "name": "Cash", "code": "cash" } ] }, { "assetClass": { "name": "Other", "code": "4" }, "subAssetClasses": [ { "name": "Other", "code": "other" } ] } ] }
Ingest the following Regions
| Region Name | Code | Countries in The Region | Countery Code |
|---|---|---|---|
| North America | US | USA | usa |
| Other | other | Other | other |
Region And Countery Stream Bundle Example
{ "regions": [ { "region": { "name": "North America", "code": "na" //code limits is 12 }, "countries": [ { "name": "USA", "code": "usa" } ] }, { "region": { "name": "Other", "code": "other" }, "countries": [ { "name": "Other", "code": "Other" } ] } ] }
Ingest the Drive Wealth Transactions Types from https://developer.drivewealth.com/reference/transaction-types-explained
Stream Bundle Transaction Types Example
{ "transaction-categories": [ { "key": "CSR", "alias": "CSR", "description": "A deposit" } ] }
DriveWealth transaction categories file
Ingest corporate actions types from here https://developer.drivewealth.com/reference/corporate-actions
Corporate Action Type ingestion is missing on Stream Portfolio Saga, and needed to be implemented first
Ingest dummy corporate action so the user journey can be tested
Dividend Action Example
DW Example:
{ "accountID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1491330741850", "accountNo": "DWEF000010", "userID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd", "transaction": { "accountAmount": 2.29, "accountBalance": 128195.27, "comment": "BPY dividend, $0.3043/share", "finTranID": "GF.861e931d-e7aa-47c8-b87a-b1e55acf3862", "wlpFinTranTypeID": "e8ff5103-ad40-4ed9-b2ee-fd96826bf935", "finTranTypeID": "DIV", "feeSec": 0, "feeTaf": 0, "feeBase": 0, "feeXtraShares": 0, "feeExchange": 0, "instrument": { "id": "476b40ee-3ff9-46af-85af-fec572d13d23", "symbol": "BPY", "name": "Brookfield Property Partners L.P." }, "dividend": { "type": "CASH", "amountPerShare": 0.3043, "taxCode": "NON_TAXABLE" } }BB Example POST /integration-api/v1/portfolio-corporate-actions
{ "id": "f8bc42eb-b973-434c-a100-69e9d248b568", "portfolioId": "9b5f82f7-2336-4efa-aff8-67e74960ec51", "corporateActionId": "e8656f12-45c5-4dc9-a945-1b7b4fd873f3", "electionQuantity": 17, "electionValue": { "amount": 34.58, "currency": "USD" }, "amountPerShare": 2.03, "additions": { "someKey": "someValue" } }
Field Mapping
BB Field DW Field **Description ** portfolioId resolvePortfolioInternalId(accountNo) resolve portfolio internal id by account number corporateActionId finTranTypeID electionQuantity.amount accountAmount amountPerShare transaction.dividend.amountPerShare additions.taxCode transaction.dividend.taxCode additions.type transaction.dividend.type
Get all available instruments, prices, and their Exchange from these endpoints
Instrument List: https://developer.drivewealth.com/reference/list-all-instruments
Exchange & Price: https://developer.drivewealth.com/reference/get-instrument-details-fundamentals
The below table mentions what instruments to ingest in DBS
| Instrument type | Adoption in Modelbank |
|---|---|
| ADR | Yes |
| ALTERNATIVE_ASSET | :cross_mark: |
| CRYPTO | :cross_mark: |
| CYBER_SECURITY | :cross_mark: |
| EQUITY | Yes |
| ETF | Yes |
| ETN | :cross_mark: |
| FX | :cross_mark: |
| INTEREST_RATE | :cross_mark: |
| METALS | :cross_mark: |
| MUTUAL_FUND | :cross_mark: |
Instruments Stream Bundle Example
{ "id": "d01c0638-fd68-4b08-a0b6-dba4c26a0673", "name": "GoHealth, Inc.", "instrumentNameLong": "GoHealth, Inc.", "code": "GOCO", "instrumentCodeCustom": "GOCO", "priceData": { "price": { "amount": 13.3, "currencyCode": "USD" }, "closePrice": 13.3 }, "price": { "amount": 13.3, "currencyCode": "USD" }, "subAssetClassCode": "EQUITY", "country": "US", "exchange": "NAQ", "about": { "about": "GoHealth, Inc. is a Medicare-focused digital health company. Its technology platform leverages modern machine-learning algorithms powered by insurance behavioral data to reimagine the optimal process for helping individuals find the health insurance plan for their specific needs. The Company operates its business in four segments: Medicare-Internal, Medicare-External, Individual and Family Plans (IFP) and Other-Internal, and IFP and Other-External. The Medicare segments focus on sales of Medicare Advantage, Medicare Supplement, Medicare prescription drug plans, and Medicare Special Needs Plans (SNPs) for multiple carriers. The Medicare Internal and External segments primarily consist of sales of products and plans through agents or external agencies. The IFP and Other segments focuses on sales of individual and family plans, dental plans, vision plans and other ancillary plans to individuals that are not Medicare-eligible. It offers services through its Encompass Platform.", "link": "https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&CIK=0001808220&owner=include&count=40&hidefilings=0" }, "canTrade": true }
DriveWealth Instruments file
API Mapping
BB API Field Source system value Descritpion id DriveWealth Id name DriveWealth name instrumentNameLong DriveWealth name code DriveWealth ISIN instrumentCodeCustom DriveWealth symbol priceData.price.amount DriveWealth lastTrade current price from referen tial quotes priceData.price.currencyCode Constant USD priceData.closePrice DriveWealth ClosePrior buyPrice.amount DriveWealth buyPrice Not visible on UI Q : is bidPrice from DBS == buyPrice from DW will be deprecated buyPrice.currencyCode Constant USD sellPrice.amount DriveWealth askPrice Not visible on UI Q : is sellPrice from DBS == askPrice from DW will be deprecated sellPrice.currencyCode Constant USD priceData.askPrice DriveWealth askPrice priceData.bidPrice DriveWealth bidPrice priceData.closePrice DriveWealth ClosePrior priceData.highPrice DriveWealth highPrice priceData.lowPrice DriveWealth lowPrice priceData.openPrice DriveWealth openPrice When the market is closed DW return openPrice as 0.0 priceData.pricePerformance DriveWealth (current price - closePrior)/closePrior priceData.pricePerformanceAbs DriveWealth current price - closePrior priceData.totalVolume DriveWealth cumulativeVolume priceData.week52Range.min DriveWealth fiftyTwoWeekLowPrice will be deprecated and replaced as separate field priceData.week52Range.max DriveWealth fiftyTwoWeekHighPrice will be deprecated as separate field pricePerformance DriveWealth subAssetClassCode DriveWealth type country Constant USA exchange DriveWealth exchange about.about DriveWealth description about.link DriveWealth url canTrade DriveWealth status If status Active then yes else false iconUrl DriveWealth image keyStatistics.fundStatus DriveWealth status not related to equrity keyStatistics.portfolioAssetsAllocation DriveWealth or Constant or skip type not related to equrity keyStatistics.priceToEarningsRatio DriveWealth fundamentalDataModel.peRatio keyStatistics.sharesOutstanding DriveWealth fundamentalDataModel.sharesOutstanding keyStatistics.priceToBookRatio DriveWealth fundamentalDataModel.pbRatio keyStatistics.earningsPerShare DriveWealth fundamentalDataModel.earningsPerShare keyStatistics.dividendYield DriveWealth fundamentalDataModel.dividendYield
TBD