Debts

Payitoff provides actionable guidance to help a Consumer pay off their Debt. Our API can be used to add a consumer's debts to the Payitoff system in order to enable further actions like generating paydown schedules. You will also find ways to retrieve debts. Both debts created by this API and those created by our Javascript widget Nexus will be listed here.

Creating and Updating Debts

Now that you have a Consumer you can start adding their Debts. We offer two simple ways to load the debts onto the consumer, our REST API endpoint or our Nexus Javascript widget.

Use REST:

• Create a Debt via our REST API
• Update Debt via our REST API

Use Nexus:

• Link Debts via our Nexus Widget
• our Nexus.linkToEnroll and Nexus.studentLoanLink (among others) can create a consumer automatically (and return their uuid in a callback) as they guide consumers through connecting their debts. You can then use that UUID in the API to find out more info and take action.

If you want to look at a consumers entire debts portfolio we offer a paydown simulator that lets you see how fast a debt can be paid down. You can provide as little as balance, type, and term (when applicable) to generate an estimated paydown schedule. Also to improve the accuracy of the paydown schedule apr and minimum_payment should be provided when available.

Student Loans

If your consumer has a debt of "type" => "STUDENT_LOAN" and you are interested in looking at Federal student loan Income-Driven Repayment options we can provide more accurate results when we know the institution_name, opened_on, balance and original_principal.

Student loans that are in default are not eligible for income driven repayment options

Listing Debts

Regardless whether the consumer linked the debts via Nexus or they were created using the API you can list their debts using our API. We support filtering the debt by type

• List Debts via our REST API

Retrieving Linked Debts

When looking at Debts that have been linked via Nexus, please note that minimum_payment will never be populated from linking. However, the estimated_minimum_payment field may often contain an amount corresponding to the scheduled monthly payment for that debt.

Deleting Debts

Only debts that were originally created via the API may be deleted. Debts that were created via Nexus Linking cannot be deleted.