Skip to main content
POST
Payoff Plan Calculation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Encoding
string

We can compress a response with gzip.

Example:

"gzip deflate"

API-Version
string

API API Version. See Versioning page for more details.

Example:

"2024-07-01"

Path Parameters

id
integer
required

An userId.

Example:

1

Body

application/json
accounts
integer[]
required

Array of account IDs

Example:
start
integer
required

Start of extra amount in hole dollars

Example:

0

end
integer
required

End of extra amount in hole dollars

Example:

1000

step
integer
required

Step of calculation hole dollars

Example:

10

Response

Returns a payment plan

avalanche
object

Repayment plans based on the avalanche method, where keys represent additional payment amounts (in dollars) added towards debt repayment.

snowball
object

Repayment plans based on the snowball method, where keys represent additional payment amounts (in dollars) added towards debt repayment.