Get Product Contract Information

Calculates and returns contract information for a retirement product contract, based on the customer's date of birth, chosen payout age, contribution plan, and portfolio allocation. This includes the accumulation period, projected performance scenarios, and a summary of contributions and subsidies.

All calculated figures (performance scenarios, contribution and subsidy totals) cover the entire full term of the retirement account, i.e. from contract start until the selected payout start date - not just a single year or period.

Use is_final=true when the returned information will be presented to the customer as the final basis for contract conclusion (e.g. right before signing). This persists the result and returns it with a non-null id. Use is_final=false (the default) for earlier, exploratory calculations (e.g. while the customer is still adjusting their inputs) - in this case the response is a preview only, before the customer has accepted the product information, and id is always null.

Note: performance_scenarios and all figures derived from them (e.g. the payin_projections and payout_projections of each scenario) are projections, not guarantees. They are calculated using assumed rates of return and can differ from the contract's actual future performance depending on market conditions.

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

A product contract identifier.

Query Params
boolean
Defaults to false

Whether the calculated contract information is final, i.e. will be used as the basis for concluding the contract, as opposed to a preliminary, exploratory preview before the customer has accepted the product information. Set to true to persist the result and receive it back with a non-null id.

Body Params
date
required

The customer's date of birth. Used to calculate the contract start date, the accumulation period, and the earliest/latest payout dates.

integer
required
65 to 70

The age at which payouts from the retirement contract begin. Must be between 65 and 70.

integer
required
65 to 85

The age at which payouts from the retirement contract end. Must be greater than or equal to payout_start_age_years, and no more than 85.

child_bonus_years
array of integers

One entry per child eligible for the child subsidy, giving how many more years that child will receive it. For example, 2 means the child receives the subsidy for 2 more years (e.g. they are 23 now and the subsidy stops after the year they turn 25). Each value must be between 1 and 25.

Child Bonus Years
string
enum
required

The subsidy status of the customer under the capital-market pension framework, which controls their government subsidy tiers:

  • direct - Qualifies on their own. Gets the full basic subsidy (Level 1 match of 50.00% plus Level 2 match of 25.00%) and full child and young_person_bonus subsidies.
  • indirect - Qualifies through a spouse's direct eligibility. Gets only the Level 1 match and full child subsidies.
  • not_eligible - Gets no subsidies at all.
Allowed:
contributions
array of objects
required
length ≥ 1

The contributions planned towards the contract. At least one entry is required, and at most one entry per type is allowed.

Contributions*

A single contribution made towards a retirement product contract.

string
enum
required

The kind of contribution made towards a retirement product contract.

  • initial: a one-off contribution made when the contract starts.
  • monthly: a recurring contribution made every month for the term of the contract.
  • transfer_in: a one-off contribution transferred in from an existing retirement contract.
Allowed:
string
required

The contribution amount, represented as a decimal string. In responses, this is formatted with two decimal places.

string
required
length between 3 and 3

An ISO 4217 three-letter currency code. The only currently available currency is "EUR".

portfolio_allocations
object
required
Headers
string
required
string
required
Responses

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