Specific Endpoint to get a breakdown of Refresh Errors
Get Nightly Refresh Status on Investments
The /GetWealthNightlyRefreshStatus endpoint can be used to reliably return the status of any unsuccessful or incomplete 'refresh' requests. You will require an Authentication Secrets Key in order to utilize this endpoint.
The most common response you will receive from this endpoint will be a 200 OK with an empty array on IneligibleWealths (indicating that all nightly requests were successful).
When a nightly refresh has stalled and/or failed - you will be returned the following information on that connection to handle as required. This includes the Institution, the LoginId (unique identifier for the user), the LastRefreshDate (the last attempted refresh), the LastRefreshState (the end state of the last refresh) and the LastRefreshErrorCode (the reason why we were unable to complete the connection). This will be returned as a list per unsuccessful connection. You should then be able to handle these errors and prompt your user to reconnect if applicable.
Please note that this endpoint will only return users where the nightly refresh has been unsuccessful and reasoning why. It will not return any information about successful connections.
In order to enable refreshes, you will need to ensure that you have the parameter 'scheduleRefresh=true" enabled in your Flinks Connect integration.
Authentication
Please note that you will need to provide a private Authentication key in order to use this endpoint. If you do not have one already provided, please reach out to [email protected]
Still unsure?
If you're still unsure how to use the
/GetWealthNightlyRefreshStatusendpoint, please reach out [email protected] and we'll work with you to make sure it is implemented correctly.