Financial Hub · Calculation
Credit line draw payments
Uses the entered rate to calculate monthly interest during the draw period, repayment principal and interest, and borrowing room.
Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.
Example result · available: 1100 USD 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 financial-hub-credit-line-draw.
Keep the key on your server. A successful call uses 1 calculation credit.
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/financial-hub-credit-line-draw";
const input = {
"value": 2000,
"balance": 500,
"draw": 1200,
"ratePercent": 12,
"repayYears": 1
};
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 -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/financial-hub-credit-line-draw' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"value": 2000,
"balance": 500,
"draw": 1200,
"ratePercent": 12,
"repayYears": 1
}
HT_INPUT
) If your request fails
400 INVALID_INPUT-
Read
error.detailswhen present. Node prints each issue. cURL returns the JSON body. Eachpathpoints 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.
401or403- Check that the server has the bearer key for the endpoint’s environment and that the key includes
financial-hub-credit-line-draw. 429- Read the service error code, check your allowance, and wait for the
Retry-Afterinterval when supplied before trying again. - Lost response,
409or503 - 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_IDto 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.
available- 1100 USD
printedAvailable- 1100
drawYears- 10
Result warnings
- The modeled draw exceeds the available amount under the 80% planning limit.
How to interpret this result
- A draw above the printed available credit is modeled at the entered amount and flagged. A positive quote is required for payments.
Full example response (JSON)
{
"status": "available",
"result": {
"available": 1100,
"printedAvailable": 1100,
"overLimit": true,
"drawYears": 10,
"repayYears": 1,
"interestOnly": 12,
"amortizing": 106.618546414
},
"formulaVersion": "financial-hub-credit-line-draw-1.0.0",
"units": {
"interestOnly": "USD/month",
"amortizing": "USD/month",
"available": "USD"
},
"assumptions": [
"A draw above the printed available credit is modeled at the entered amount and flagged. A positive quote is required for payments."
],
"warnings": [
"The modeled draw exceeds the available amount under the 80% planning limit."
],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
valueRequiredCurrent home value (USD, to the cent).
Min 0.01 · Max 10000000000 · Step 0.01balanceOptionalFirst mortgage balance (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01secondBalanceOptionalCombined other liens (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01drawRequiredRequested draw (USD, to the cent).
Min 0 · Max 10000000000 · Step 0.01ratePercentOptionalQuoted annual draw and repayment rate (percentage points, up to six decimals).
Min 0 · Max 100 · Step 0.000001drawYearsOptionalDraw period in years. Defaults to 10.
Min 0 · Max 100repayYearsOptionalRepayment period in years. Defaults to 20.
Min 0.08333333333333333 · Max 100Example request body (JSON)
{
"value": 2000,
"balance": 500,
"draw": 1200,
"ratePercent": 12,
"repayYears": 1
} Full JSON schema
{
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Current home value (USD, to the cent).",
"minimum": 0.01,
"maximum": 10000000000,
"multipleOf": 0.01
},
"balance": {
"type": "number",
"description": "First mortgage balance (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"secondBalance": {
"type": "number",
"description": "Combined other liens (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"draw": {
"type": "number",
"description": "Requested draw (USD, to the cent).",
"minimum": 0,
"maximum": 10000000000,
"multipleOf": 0.01
},
"ratePercent": {
"type": "number",
"description": "Quoted annual draw and repayment rate (percentage points, up to six decimals).",
"minimum": 0,
"maximum": 100,
"multipleOf": 0.000001
},
"drawYears": {
"type": "number",
"description": "Draw period in years. Defaults to 10.",
"minimum": 0,
"maximum": 100
},
"repayYears": {
"type": "number",
"description": "Repayment period in years. Defaults to 20.",
"minimum": 0.08333333333333333,
"maximum": 100
}
},
"required": [
"value",
"draw"
],
"additionalProperties": false
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-credit-line-draw
Formula: financial-hub-credit-line-draw-1.0.0