Skip to content

Lending · Calculation

Vehicle refinance and term comparison

Compares the old and new payments, total cost, interest, effective APR and five alternate new terms.

Example result · actualCurrentPayment: 100 See output

Cost per success
1 calculation credit
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Make a request

Use a production key scoped to auto-refinance-comparison.

Keep the key on your server. A successful call uses 1 calculation credit.

Production request

Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.

import { randomUUID } from "node:crypto";

const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/auto-refinance-comparison";
const input = {
  "currentBalance": 1200,
  "currentRate": 0,
  "currentTermRemaining": 12,
  "newRate": 0,
  "newTerm": 24,
  "refiCosts": 120,
  "isAdvanced": true
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);

const response = await fetch(endpoint, {
  method: "POST",
  redirect: "error",
  headers: {
    "Authorization": "Bearer " + key,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId
  },
  body: JSON.stringify(input)
});
if (!response.ok) {
  const problem = await response.json().catch(() => null);
  const code = problem?.error?.code || response.statusText;
  const delay = response.headers.get("retry-after");
  if (delay) console.error("Retry-After (seconds):", delay);
  console.error("HTTP " + response.status + " " + code + ". Usage lookup ID: " + requestId);
  if (Array.isArray(problem?.error?.details)) {
    for (const issue of problem.error.details) console.error("Input issue:", JSON.stringify(issue));
  }
  process.exitCode = 1;
} else {
  console.log(JSON.stringify(await response.json(), null, 2));
}
cURL (shell)

Set HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  set -eu
  : "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
  request_id="${HT_REQUEST_ID:-}"
  if [ -z "$request_id" ]; then
    request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
  fi
  printf 'Usage lookup ID: %s\n' "$request_id" >&2
  # On INVALID_INPUT, read error.details in the JSON response body.
  curl --disable --silent --show-error --fail-with-body --include \
    --request POST 'https://calc.hasstechapi.com/v2/calc/auto-refinance-comparison' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "currentBalance": 1200,
  "currentRate": 0,
  "currentTermRemaining": 12,
  "newRate": 0,
  "newTerm": 24,
  "refiCosts": 120,
  "isAdvanced": true
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points into your request. An empty path refers to the whole body.

Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes auto-refinance-comparison.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set HT_REQUEST_ID to the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.

The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.

Output

Example result

These values come from running this operation on the example inputs.

actualCurrentPayment
100
newPayment
55
monthlySavings
45 USD/month

Result warnings

  • The lower monthly payment costs more over the new term.
How to interpret this result
  • Simple mode ignores costs. Advanced mode finances them. Break-even uses the rate-only payment difference before costs are financed. A zero break-even month alone does not establish a benefit.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "actualCurrentPayment": 100,
    "newPayment": 55,
    "monthlySavings": 45,
    "totalSavings": -120,
    "interestSavings": 0,
    "breakEvenMonths": 3,
    "rateOnlyMonthlySavings": 50,
    "chartData": [
      {
        "name": "Monthly Payment",
        "Current": 100,
        "New": 55
      },
      {
        "name": "Total Interest",
        "Current": 0,
        "New": 0
      },
      {
        "name": "Total Cost",
        "Current": 1200,
        "New": 1320
      }
    ],
    "worthIt": false,
    "hasValidTerms": true,
    "extraMonths": 12,
    "newLoanAprPct": 9.323544233334037,
    "effectiveRefiCosts": 120,
    "printed": {
      "interestSavings": 0,
      "totalSavings": -120,
      "monthlyChange": 45,
      "newBalance": 1320
    },
    "termLadder": [
      {
        "term": 24,
        "newPayment": 55,
        "totalSavings": -120
      },
      {
        "term": 36,
        "newPayment": 36.6666666667,
        "totalSavings": -120
      },
      {
        "term": 48,
        "newPayment": 27.5,
        "totalSavings": -120
      },
      {
        "term": 60,
        "newPayment": 22,
        "totalSavings": -120
      },
      {
        "term": 72,
        "newPayment": 18.3333333333,
        "totalSavings": -120
      }
    ]
  },
  "formulaVersion": "auto-refinance-comparison-1.0.0",
  "units": {
    "money": "USD",
    "monthlySavings": "USD/month",
    "newLoanAprPct": "percent per year",
    "breakEvenMonths": "months"
  },
  "assumptions": [
    "Simple mode ignores costs. Advanced mode finances them. Break-even uses the rate-only payment difference before costs are financed. A zero break-even month alone does not establish a benefit."
  ],
  "warnings": [
    "The lower monthly payment costs more over the new term."
  ],
  "creditCost": 1
}

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

currentBalanceRequired
number

Unpaid vehicle loan balance (USD, cents).

Min 0.01 · Max 1000000000 · Step 0.01
currentRateRequired
number

Current APR (percentage points, up to 6 decimals).

Min 0 · Max 100 · Step 0.000001
currentTermRemainingRequired
integer

Term in whole months.

Min 1 · Max 1200
newRateRequired
number

New note rate (percentage points, up to 6 decimals).

Min 0 · Max 100 · Step 0.000001
newTermRequired
integer

Term in whole months.

Min 1 · Max 1200
refiCostsRequired
number

Costs financed with the new loan in advanced mode (USD, cents).

Min 0 · Max 1000000000 · Step 0.01
isAdvancedRequired
boolean

Include refinance costs when true (advanced). Ignore them in simple mode.

Example request body (JSON)
{
  "currentBalance": 1200,
  "currentRate": 0,
  "currentTermRemaining": 12,
  "newRate": 0,
  "newTerm": 24,
  "refiCosts": 120,
  "isAdvanced": true
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "currentBalance": {
      "type": "number",
      "description": "Unpaid vehicle loan balance (USD, cents).",
      "minimum": 0.01,
      "maximum": 1000000000,
      "multipleOf": 0.01
    },
    "currentRate": {
      "type": "number",
      "description": "Current APR (percentage points, up to 6 decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "currentTermRemaining": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1200,
      "description": "Term in whole months."
    },
    "newRate": {
      "type": "number",
      "description": "New note rate (percentage points, up to 6 decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "newTerm": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1200,
      "description": "Term in whole months."
    },
    "refiCosts": {
      "type": "number",
      "description": "Costs financed with the new loan in advanced mode (USD, cents).",
      "minimum": 0,
      "maximum": 1000000000,
      "multipleOf": 0.01
    },
    "isAdvanced": {
      "type": "boolean",
      "description": "Include refinance costs when true (advanced). Ignore them in simple mode."
    }
  },
  "required": [
    "currentBalance",
    "currentRate",
    "currentTermRemaining",
    "newRate",
    "newTerm",
    "refiCosts",
    "isAdvanced"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/auto-refinance-comparison
Formula: auto-refinance-comparison-1.0.0