Debt Crusher
Create intelligent debt repayment plans using avalanche or snowball strategies. Simulate payoff timelines and track progress against targets.
/api/v1/engine/debtEndpoints
POST
/api/v1/engine/debt/planSoonCreate a new debt repayment plan
POST
/api/v1/engine/debt/simulateSoonSimulate payoff timeline with different strategies
GET
/api/v1/engine/debt/{plan_id}/progressSoonTrack progress against repayment targets
PATCH
/api/v1/engine/debt/{plan_id}SoonUpdate plan parameters or strategy
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| debts | array | Required | List of debts with balance, rate (bps), and minimum payment (pence) |
| monthly_budget | integer | Required | Total monthly debt budget in pence |
| strategy | string | Optional | Repayment strategy: avalanche (highest rate) or snowball (lowest balance) |
Example
Request
http
POST /api/v1/engine/debt/simulate HTTP/1.1
Host: api.tpay365.com
Authorization: Bearer sk_live_abc123
Content-Type: application/json
{
"debts": [
{ "name": "Credit Card", "balance": 450000, "rate": 2190, "minimum": 5000 },
{ "name": "Personal Loan", "balance": 800000, "rate": 890, "minimum": 15000 }
],
"monthly_budget": 30000,
"strategy": "avalanche"
}Response
json
{
"strategy": "avalanche",
"total_months": 48,
"total_interest_paid": 185230,
"total_paid": 1435230,
"payoff_schedule": [
{ "month": 1, "debt": "Credit Card", "payment": 15000, "remaining": 443175 },
{ "month": 1, "debt": "Personal Loan", "payment": 15000, "remaining": 790933 }
],
"savings_vs_minimum": 42870
}