Create interest forecast [Beta]

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:

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Interest forecast request

string
required
length ≤ 36

Client-generated forecast UUID in the hyphenated 36-character format (8-4-4-4-12). A UUID without hyphens returns a 400 error. Do not reuse the forecast_id of a previous request. Letters are accepted in either case and returned in lowercase.

string
length ≤ 64

Division ID. When not provided, defaults to DEFAULT_DIVISION internally.

string
required

Account ID. Must be between 1 and 64.

string
length ≤ 60

External account ID managed by the requester

string
required
length between 36 and 36

Interest plan ID generated during the plan's creation. Must be an alphanumeric UUID with the alphabetical characters in lowercase.

date
required

Date to calculate the forecast for. Must be equal to or later than the current date (UTC). Format = YYYY-MM-DD.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json