Skip to navigation

Recalculate repayments

Recalculates repayment amounts for a specific rate bracket result. Used when the user adjusts parameters on an individual result card (e.g., changing balloon amount or rate).

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Request

This endpoint expects an object.
rate_bracket_idintegerRequired
base_mindoubleRequired
The edited annual rate, as a percentage
base_maxdoubleRequired
The edited annual rate, as a percentage
compounding_freq_valueintegerRequired
pvdoubleRequired
balloondoubleRequired
costdoubleRequired
depositdoubleRequired
noi_mindoubleRequired
noi_maxdoubleRequired
billing_typestring or nullRequired

advance; anything else prices in arrears

repayment_frequencyenumRequired

none prices monthly.

Response

Recalculated result
rate_bracket_idintegerOptional
r_mindoubleOptional
r_maxdoubleOptional
repayment_mindoubleOptional
repayment_maxdoubleOptional
e_mindoubleOptional
e_maxdoubleOptional

Errors

500
Internal Server Error