Request a forecast of the gross interest and the gross balance that an interest-bearing account is expected to have on forecast_date.
The forecast is asynchronous. The 200 response only confirms receipt of the request and does not contain forecast values. A failure event reports any problem with the interest plan or account.
The following events deliver endpoint results:
- Interest forecast succeeded when the forecast is calculated
- Interest forecast failed when the forecast cannot be calculated
If a request repeats a forecast_id, the endpoint still returns 200, and an Interest forecast failed event reports the message The provided forecast_id has already been used.
In rare cases, such as a retry after a temporary failure, you can receive the same event more than once. All events for a request carry its forecast_id, so you can use it to recognize and ignore a repeated event.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||