Skip to content

Financial Hub · Calculation

Debt terms from statement figures

Estimates a card APR from charged interest and average balances, or calculates missing installment payment, remaining installments and final due date.

Open Financial Hub in HT Calc

Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.

Example result · apr: 24 percent per year 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-statement-inference.

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/financial-hub-statement-inference";
const input = {
  "kind": "credit_card",
  "balance": 900,
  "previousBalance": 1100,
  "interestCharged": 20
};
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/financial-hub-statement-inference' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "kind": "credit_card",
  "balance": 900,
  "previousBalance": 1100,
  "interestCharged": 20
}
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 financial-hub-statement-inference.
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.

apr
24 percent per year
How to interpret this result
  • All observations come from caller-entered fields. Inferred APR is rounded to two decimals and the Hub accepts only results above zero and below 100%.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "apr": 24,
    "estimatedApr": true,
    "payment": null,
    "estimatedPayment": false,
    "remaining": null,
    "dueDay": null,
    "nextDueOn": null,
    "lastDueOn": null
  },
  "formulaVersion": "financial-hub-statement-inference-1.0.0",
  "units": {
    "apr": "percent per year",
    "payment": "USD/month",
    "remaining": "months"
  },
  "assumptions": [
    "All observations come from caller-entered fields. Inferred APR is rounded to two decimals and the Hub accepts only results above zero and below 100%."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

kindRequired
string

Source of payment and APR.

Allowed: "credit_card", "installment"
balanceRequired
number

Current statement balance (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
previousBalanceOptional
number

Previous card statement balance (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
interestChargedOptional
number

Interest charged for the statement month (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
aprOptional
number

Stated APR (percentage points, up to six decimals).

Min 0 · Max 100 · Step 0.000001
paymentOptional
number

Scheduled installment or card minimum per month (USD, to the cent).

Min 0 · Max 10000000000 · Step 0.01
originalAmountOptional
number

Original installment principal (USD, to the cent).

Min 0.01 · Max 10000000000 · Step 0.01
termMonthsOptional
integer

Original installment term (whole months).

Min 1 · Max 1200
dueOnOptional
string

Payment due date on the statement

Format: date · Min length 10 · Max length 10
asOfDateOptional
string

Statement date, or evaluation date if unknown

Format: date · Min length 10 · Max length 10
Example request body (JSON)
{
  "kind": "credit_card",
  "balance": 900,
  "previousBalance": 1100,
  "interestCharged": 20
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Source of payment and APR.",
      "enum": [
        "credit_card",
        "installment"
      ]
    },
    "balance": {
      "type": "number",
      "description": "Current statement balance (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "previousBalance": {
      "type": "number",
      "description": "Previous card statement balance (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "interestCharged": {
      "type": "number",
      "description": "Interest charged for the statement month (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "apr": {
      "type": "number",
      "description": "Stated APR (percentage points, up to six decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "payment": {
      "type": "number",
      "description": "Scheduled installment or card minimum per month (USD, to the cent).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "originalAmount": {
      "type": "number",
      "description": "Original installment principal (USD, to the cent).",
      "minimum": 0.01,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "termMonths": {
      "type": "integer",
      "description": "Original installment term (whole months).",
      "minimum": 1,
      "maximum": 1200
    },
    "dueOn": {
      "type": "string",
      "description": "Payment due date on the statement",
      "format": "date",
      "minLength": 10,
      "maxLength": 10,
      "pattern": "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$"
    },
    "asOfDate": {
      "type": "string",
      "description": "Statement date, or evaluation date if unknown",
      "format": "date",
      "minLength": 10,
      "maxLength": 10,
      "pattern": "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$"
    }
  },
  "required": [
    "kind",
    "balance"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "kind": {
            "const": "credit_card"
          }
        },
        "required": [
          "kind"
        ]
      },
      "then": {
        "not": {
          "anyOf": [
            {
              "required": [
                "originalAmount"
              ]
            },
            {
              "required": [
                "termMonths"
              ]
            }
          ]
        }
      }
    },
    {
      "if": {
        "properties": {
          "kind": {
            "const": "installment"
          }
        },
        "required": [
          "kind"
        ]
      },
      "then": {
        "not": {
          "anyOf": [
            {
              "required": [
                "previousBalance"
              ]
            },
            {
              "required": [
                "interestCharged"
              ]
            }
          ]
        }
      }
    }
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-statement-inference
Formula: financial-hub-statement-inference-1.0.0