FAQ
Welcome to Wealthica's Frequently Asked Questions! Whether you're a developer exploring the possibilities of financial technology or a business seeking seamless integration with investment accounts and financial data providers, find answers to common queries about Wealthica's robust API solutions here.
What is the sync_status_details field?
The sync_status_details field provides a detailed overview of the synchronization status for various data types during the last sync. It includes subfields such as investments, positions, transactions, and documents. This field is updated only after the entire synchronization process is complete.
When you connect your account to Wealthica, it is common for the sync status to display as "syncing" for a short while, even if some data types (like investments or positions) have already been synchronized. This delay occurs because the field is not updated in real-time.
The sync_status_details field is not dynamic. Its purpose is to provide information about the status of the most recent sync, including which steps were completed successfully and where retries or errors occurred.
What's the difference between sync_date and sync_request_date?
sync_date: This represents the date of the last successful synchronization. Failed sync attempts will not update this field, meaning it always reflects the most recent successful sync.sync_request_date: This indicates the date and time when the last sync was requested, regardless of whether the sync was successful or not. It updates every time a sync attempt is made.
In summary, sync_date is updated only after a successful sync, while sync_request_date tracks all sync attempts.
What's the daily_sync field?
The daily_sync field, when set to true, enables automatic synchronization of data on a daily basis. However, it is important to note that daily syncs may not work for all institutions and could fail at times due to session expirations or the requirement for two-factor authentication (2FA).
To maintain consistent daily synchronization, it is recommended to have a user interface (UI) that allows users to "fix" the connection by re-establishing a new session when needed. This ensures seamless updates while addressing any disruptions caused by session or authentication issues.
Is there a way to test the sync/connection?
Yes, for testing purposes you can use the Demo institution (type : demo ).
To know more about it please visit Wealthica Docs for demo institution.
How will I know when the sync is complete and the data is ready?
You can configure a webhook to receive an alert. This is a paid feature. Please find the webhook documentation here.
What is the difference between a manual sync and a regular API call?
Manual syncs retrieve the latest data directly from the connected sources. To get the most recent transactions, you can perform a manual sync.
API calls only access data stored in our database. If you have not triggered a manual sync, this information is from the last time we synced this account. This is usually done daily via the daily sync.
How do I get the latest transactions?
To get the most recent transactions, you can perform a manual sync. Manual syncs retrieve the latest data directly from the connected sources, rather than relying on API calls that may only access data stored in our database.
Is there a page to check the ongoing incidents/outage for connectors?
Yes! you can visit our Freshstatus page to know about the ongoing issues, it's possible that you may not find the connector you're facing the issue with as these are posted/updated by general reports or by us identifiying the issues beforehand.
What are some of the investment types that Wealthica supports?
Below is the list of all the supported investment types across different connectors:
| Type | Description |
|---|---|
| cash | Cash Account |
| tfsa | Tax Free Savings Account |
| rrsp | Registered Retirement Savings Plan |
| resp | Registered Education Savings Plan |
| rdsp | Registered Disability Savings Plan |
| margin | Margin Account |
| short | Short Margin Account |
| long | Long Margin Account |
| lira | Locked-in Retirement Account |
| lrsp | Locked-in Retirement Savings Plan |
| rlsp | Restricted Locked-in Savings Plan |
| rrif | Registered Retirement Income Fund |
| lif | Life Income Fund |
| lrif | Locked-in Retirement Income Fund |
| prif | Prescribed Registered Retirement Income Fund |
| rpp | Registered Pension Plan |
| ipp | Individual Pension Plan |
| dpsp | Deferred Profit-Sharing Plan |
| spp | Quebec/Manitoba Simplified Pension Plan |
| ndcp | Notional Defined Contribution Plan |
| nrsp | Non-Registered Savings Plan |
| epsp | Employee Profit Sharing Plan |
| espp | Employee Stock Purchase Plan |
| esop | Employee Stock Option Plan |
| vrsp | Voluntary Retirement Savings Plan (Quebec) |
| esp | Employee Savings Plan |
| rsu | Restricted Stock Unit |
| rsa | Restricted Stock Award |
| psu | Performance Stock Unit |
| fhsa | First Home Savings Account |
| gic | Guaranteed Investment Certificate |
| trust | Trust Account |
| chequing | Chequing |
| credit | Credit Account, Credit Card |
| loan | Loan |
| loc | Line of Credit |
| heloc | Home Equity Line of Credit |
| mortgage | Mortgage |
| savings | Savings account |
| ira | (US) Individual Retirement Account |
| 401k | (US) 401k Retirement Account |
| roth | (US) Roth Account (IRA or 401K) |
| isa | (UK) Individual Savings Accounts |
| sipp | (UK) Self-Invested Personal Pension |
| unknown | Unknown Account |
What's the difference between currency_value and value?
The key difference lies in how the amounts are represented:
currency_value: This provides the amount exactly as it is reported in the account's native currency. It reflects the actual balance or value in the currency associated with the account, without any conversion.value: This gives the amount converted into the user's preferred currency. It applies the applicable exchange rates to calculate the equivalent value in the user's chosen currency, offering a consistent view of account balances across different currencies.
In summary, use currency_value when you need the raw amount in the account's original currency, and use value for a unified view in the user's preferred currency.