➖Wealth
Last updated
Last updated
The Wealth product is an extension of the Bank product. Beyond the collection of PSD2-compliant accounts, Wealth extends the scope to all other accounts (loans, savings accounts, market accounts, life insurances, retirement savings, company savings…).
Wealth also enables the collection of additional information on these accounts, such as the valuation, the valuation differential and the previous differential.
Finally, Wealth enables the retrieval of three additional resources of wealth accounts:
(financial assets of the account)
(free shares, for company savings accounts only)
(for market accounts & equity savings plans only)
Loan amortizations (for loans accounts)
Wealth thus offers a complete view of the end-user's patrimonial assets.
Wealth features can be activated by your Account Manager only. Basic activation includes:
the collection of additional information on wealth accounts (valuation, valuation differential, previous differential…);
the retrieval of investments on wealth accounts;
the retrieval of pockets (free shares), specifically for company savings accounts.
Finally, the collection of market orders can also be independently activated.
As mentioned above, activating the API enables the collection of additional information for wealth accounts.
These attributes appear in the usual routes used to query accounts:
It contains a list of attributes that are related to the account, as well as an investments key containing a list of the investments for this account. If the account does not have any investment or if the investments are not implemented for this account type, the API will return an empty list.
The calculated key indicates the list of attributes that are calculated and not directly obtained from the bank (for example, valuation is the sum of scraped investments valuations for a given account).
Even though the investment attributes are updated at each synchronization, the history of all unit values, original unit values, original currencies and valuation dates is saved and can be accessed via the API:
This information can be used to build graphs of the value of each investment from the first time this investment was collected until the most recent synchronization.
Since many accounts contain identical investments (i.e. that have the same ISIN code), some of the information is grouped in a resource called "Finance securities". This resource enables the collection of additional information for each unique investment of the database, such as the investment type and the investment values.
The history depth depends of the investment: for most investments the history depth is one month (which includes daily values), but for some investments only today's unit value is available. In any case, the unit values and their corresponding dates are collected an exposed as vdate / unitvalue couples in the API.
This history of investment values can be used to build graphs of the evolution of the unit value of each stock from the first time we collected this information until today.
This service is partly redundant with the history of a single investment (/investments/{investmentId}/history route), both can be used and have their specificities and advantages. The security history route is common to all investments with the same ISIN, thus the history depth is usually bigger, however the data comes from the Boursorama website therefore there might be discrepancies between the unit values collected there and the actual unit values collected from the customer's website. In addition, the investment history route also contains the original unit values and currencies, when applicable.
Major companies and corporations sometimes give a part of their own stocks to their employees without any financial requirement. These freely given stocks are called Pockets or Free shares and can be found on connectors specialized in employee savings accounts (for example BNP, Natixis and Amundi).
Market Orders have some attributes in common with Investments, for example id, code, label, quantity, unitprice and unitvalue.
They also have specific attributes, such as the order direction and type of the Market Order, the current state of the Market Order and the Stock Market on which the order was placed.
A Market Order can have up to 3 associated dates: the creation date, the execution date and the validity date (which is usually 3 months after the creation date).
During every synchronization, all market orders are collected and matched with the previous market order list using a stable unique identifier. If there is no such identifer on a given website, the matching is done using static attributes: date, label, code and direction (most of the other attributes may vary between the market order creation and its execution or expiration). If a Market Order is matched with a previously collected item, its attributes will be updated, otherwise a new item will is created. The Market Order history depth depends on the website: on some websites, several years of Market Order history are displayed whereas on some others, only pending market orders are available and they disappear after execution.
This feature is not activated by default. Please contact your Customer Success Manager to activate it.
Loan Amortizations correspond to the amortization paid by a user for a loan. Most of the amortization tables available in the user's banking space are updated once a month, starting from the current month or year. We therefore update the information once a month, and the amortization will begin at the earliest on the date of the first synchronization.
The calculated key indicates the list of attributes that are calculated and not directly obtained from the bank (for example, total_payment_amount is the sum of scraped amortization, interest and insurance amounts for a given amortization).
| Type | Description |
|---|---|
As an optional feature, you can also enable the collection of for investments when available, mainly for connectors specialized in employee and company savings accounts (PER, PEE, PERP, PERCO, Madelin…).
| Property | Description |
|---|---|
The are the financial assets of a wealth account. They can be financial equities, actions, obligations, Euro funds, unit-linked contracts or even liquidities:
When the configuration key is activated (get in touch with your Account Manager for details), for each Finance security that has a valid ISIN code, we fetch additional information on the Boursorama website: the investment type (id_type) on an and the unit value history.
On these employee savings accounts, Investments are often divided into several that have different availability dates and conditions. The most common availability condition is the retirement of the employee, but it can also be at a specific date in the future (for example 5 years after the Pocket was issued), in which case the Pocket will have an availability date. If the availability date is in the past, the Pocket is already available, hence the displayed condition will be available.
Market Orders correspond to the purchases and sales of financial equities, actions and obligations on Market accounts and Equity savings plans (PEA). The collection of Market Orders provides an overview of the history of financial movements on these accounts. are currently implemented on most major bank connectors (Crédit Agricole, Caisse d'épargne, BNP Paribas, Société Générale, Boursorama, Fortuneo…), as well as websites specialized in stock exchange, such as online brokers (Binck, Degiro, Boursedirect...).