tools

Simulate debt payoff

Use this when the user asks to compare debt payoff strategies. Simulate paying off debts by avalanche (highest APR first) or snowball (smallest balance first), with an optional extra monthly payment. Refuses with missingInputs when a balance, APR, minimum payment, or FX rate is missing; betteroff_propose_debt_details saves terms the user states. Read-only; never moves money.

post/v1/tools/betteroff_simulate_debt_payoff

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_simulate_debt_payoff
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: debts:read)
    • HTTP bearer

Request body

strategy'avalanche' | 'snowball' required

avalanche = highest APR first (minimizes interest); snowball = smallest balance first (faster early wins).

extraMonthlynumber required

Extra amount paid toward debts each month beyond the minimums, in the user's base currency. Use 0 for none.

Response

Tool result

OR

Changes

No recorded changes to this operation across all 1 revision of this API.