HomeGuidesAPI Reference
Guides

Paydown Schedules

Paydown schedules can be generated from a subset of Debts on a Consumer using various payoff strategies. When generating multiple strategies, you can compare them to each other to better understand the outcomes.

Get a Paydown Schedule for a subset of a consumer's debts

To create a paydown schedule for a Consumer using default settings, the most minimal information you need is to pass the Consumer UUID in the path and the UUIDs of the Debts that you want to run the schedule on as a query parameter.

// GET /api/v3.0.0/consumers/af076fdc-0e36-4188-a1bc-8ed87af836c2/paydown_schedule?debt_ids%5B%5D=2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a&debt_ids%5B%5D=31321a02-ca45-4f36-a6ce-138228a40065

For best results, the debts should consist of credit cards and personal loans.

Using options

To dial in the results of your schedule, you can pass additional options. Options are:

algorithm

Supported values for algorithm are AVALANCHE, SNOWBALL and MINIMUMS. Both Avalanche and Snowball focus on paying off individual debts sequentially to accelerate the payoff of the entire debt portfolio. Avalanche begins by focusing on the highest APR debt while Snowball begins with the lowest balance. Each of these provide similarly beneficial outcomes for the consumer. The Minimums algorithm simply projects the schedule and cost when only the minimum payments are made.

goal

By default, the system will try to find the lowest overpayment that would clear the provided debts in 60 months (5 years). You can adjust this timeline by setting the goal to the desired number of months.

overpayment_limit

An overpaymentLimit can optionally be set to avoid recommending payments above what the consumer is able to afford. This is the amount paid in addition to the sum of the minimum payments on all of the debts.

An example of calling the endpoint with all of the options:

// GET /api/v3.0.0/consumers/af076fdc-0e36-4188-a1bc-8ed87af836c2/paydown_schedule?algorithm=SNOWBALL&overpayment_limit=175&debt_ids%5B%5D=2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a&debt_ids%5B%5D=31321a02-ca45-4f36-a6ce-138228a40065

Paydown Schedule Response

The schedule output will contain a list of all payments made to meet the goal or the best payments that can be made within the overpayment limit.

The summary details the results at a high level including information such as total interest paid, how many months it took to pay off all the debts, and the amount of overpayment beyond the minimums.

{
	"data": {
		"summary": {
			"name": "an accelerated paydown (snowball) plus $0",
			"result": "paid_off",
			"months": 36,
			"interest": "1698.40",
			"note": "",
			"initial_payment": "765.10",
			"overpayment": "0"
		},
		"schedule": [
			{
				"date": "2027-08-07",
				"payment": "89.00",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-07-07",
				"payment": "765.10",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-06-07",
				"payment": "765.23",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-05-07",
				"payment": "765.28",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-04-07",
				"payment": "765.34",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-03-07",
				"payment": "765.37",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-02-07",
				"payment": "765.46",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2027-01-07",
				"payment": "765.51",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2026-12-07",
				"payment": "765.56",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2026-11-07",
				"payment": "765.63",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2026-10-07",
				"payment": "765.67",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2026-09-07",
				"payment": "765.74",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": false
			},
			{
				"date": "2026-08-07",
				"payment": "95.82",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": true
			},
			{
				"date": "2026-08-07",
				"payment": "169.76",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-07-07",
				"payment": "593.18",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-07-07",
				"payment": "172.56",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-06-07",
				"payment": "590.34",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-06-07",
				"payment": "175.43",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-05-07",
				"payment": "587.43",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-05-07",
				"payment": "178.33",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-04-07",
				"payment": "584.50",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-04-07",
				"payment": "181.30",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-03-07",
				"payment": "581.45",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-03-07",
				"payment": "184.29",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-02-07",
				"payment": "578.41",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-02-07",
				"payment": "187.41",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2026-01-07",
				"payment": "575.33",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2026-01-07",
				"payment": "190.50",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-12-07",
				"payment": "572.17",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-12-07",
				"payment": "193.65",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-11-07",
				"payment": "568.99",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-11-07",
				"payment": "196.87",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-10-07",
				"payment": "565.72",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-10-07",
				"payment": "200.12",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-09-07",
				"payment": "562.43",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-09-07",
				"payment": "203.45",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-08-07",
				"payment": "559.08",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-08-07",
				"payment": "206.81",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-07-07",
				"payment": "555.65",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-07-07",
				"payment": "210.23",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-06-07",
				"payment": "552.19",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-06-07",
				"payment": "213.73",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-05-07",
				"payment": "548.65",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-05-07",
				"payment": "217.25",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-04-07",
				"payment": "545.08",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-04-07",
				"payment": "220.87",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-03-07",
				"payment": "541.36",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-03-07",
				"payment": "224.52",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-02-07",
				"payment": "537.66",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-02-07",
				"payment": "228.31",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2025-01-07",
				"payment": "533.91",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2025-01-07",
				"payment": "232.08",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2024-12-07",
				"payment": "530.06",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2024-12-07",
				"payment": "235.91",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2024-11-07",
				"payment": "526.18",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2024-11-07",
				"payment": "239.84",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2024-10-07",
				"payment": "522.20",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": false
			},
			{
				"date": "2024-10-07",
				"payment": "243.80",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			},
			{
				"date": "2024-09-07",
				"payment": "518.19",
				"debt_id": "2d4764c5-7b8f-4075-bee3-e3d0b4f67e0a",
				"minimum": true
			},
			{
				"date": "2024-09-07",
				"payment": "247.86",
				"debt_id": "31321a02-ca45-4f36-a6ce-138228a40065",
				"minimum": true
			}
		]
	}
}