Compute a debt payoff plan
curl -X POST "https://api.403fin.io/v1/debt/payoff-plan" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"liability_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"strategy": "snowball",
"custom_order": [
"123e4567-e89b-12d3-a456-426614174000"
],
"total_monthly_budget": "example_string",
"extra_monthly_payment": "example_string"
}'
import requests
import json
url = "https://api.403fin.io/v1/debt/payoff-plan"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"liability_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"strategy": "snowball",
"custom_order": [
"123e4567-e89b-12d3-a456-426614174000"
],
"total_monthly_budget": "example_string",
"extra_monthly_payment": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.403fin.io/v1/debt/payoff-plan", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"liability_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"strategy": "snowball",
"custom_order": [
"123e4567-e89b-12d3-a456-426614174000"
],
"total_monthly_budget": "example_string",
"extra_monthly_payment": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"liability_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"strategy": "snowball",
"custom_order": [
"123e4567-e89b-12d3-a456-426614174000"
],
"total_monthly_budget": "example_string",
"extra_monthly_payment": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.403fin.io/v1/debt/payoff-plan", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.403fin.io/v1/debt/payoff-plan')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"liability_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"strategy": "snowball",
"custom_order": [
"123e4567-e89b-12d3-a456-426614174000"
],
"total_monthly_budget": "example_string",
"extra_monthly_payment": "example_string"
}'
response = http.request(request)
puts response.body
{
"data": {
"debts": [
{
"liability_id": "123e4567-e89b-12d3-a456-426614174000",
"payoff_month": 42,
"payoff_date": "2024-12-25",
"total_interest": "example_string",
"total_paid": "example_string",
"payoff_order": 42,
"negative_amortization": true
}
],
"debt_free_date": "2024-12-25",
"total_interest": "example_string",
"total_paid": "example_string",
"baseline_total_interest": "example_string",
"interest_saved_vs_minimum": "example_string",
"minimum_required_budget": "example_string",
"currency": "example_string",
"budget_insufficient": true,
"plan_feasible": true,
"horizon_exceeded": true,
"assumptions": [
"example_string"
],
"timeline": [
{
"month": "example_string",
"total_balance": "example_string",
"cumulative_interest": "example_string",
"debts": [
{
"liability_id": "123e4567-e89b-12d3-a456-426614174000",
"balance": "example_string"
}
]
}
],
"excluded": [
{
"liability_id": "123e4567-e89b-12d3-a456-426614174000",
"reason": "example_string"
}
]
},
"pagination": {
"next_cursor": "example_string",
"has_more": true
},
"redacted_fields": [
"example_string"
],
"filtered": true
}
{}
/v1/debt/payoff-plan
Target server for requests. Edit to use your own host.
An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
An opaque ff_ credential presented in the X-API-Key header.
The media type of the request body
The explicit payoff order when strategy is custom.
A decimal amount string.
A decimal amount string.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.
Body
snowballavalanchecustomThe explicit payoff order when strategy is custom.
A decimal amount string.
A decimal amount string.
Responses
Cursor pagination state, present on list endpoints.
Field ids stripped from the payload by connection scope.
True when row or aggregate filtering is in effect for this response.