API Reference

Preview Refinance Schedule

post
https://{your-totality-url}.com/api/loans/refinance-schedule

Compute an amortization schedule for a proposed refinance of an existing loan without persisting anything. The server derives the new principal, interest rate, and number of payments from the referenced loan's group settings (loan type APR options, gamification tier, and refinance offer source). Optional overrides are accepted for originalPrincipalAmount, interestRate, and numberOfPayments.

When originalPrincipalAmount is supplied it must be strictly greater than the original loan's payoff amount.

Use this to show the borrower their projected payment schedule before committing to create the refinance. No Loan or ScheduledPayment rows are created as a result of this call.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
integer
≥ 1
date
date | null

Optional override. When omitted, defaults to the original loan's next scheduled payment date.

integer
number | null

Optional override. When omitted, the rate is derived from the loan group's refinance settings (tier default rate, or the next-lower configured APR option on the loan type).

boolean
integer | null
≥ 1

Optional override. When omitted, defaults to the original loan's number of payments.

integer | null
≥ 1

Optional override of the new loan principal (cents). When supplied, must be strictly greater than the original loan's payoff amount. When omitted, the principal is derived from the loan group's refinance offer source (add_amount, previous_amount, or credit_limit).

string
enum

Optional. Defaults to the original loan's payment frequency.

Allowed:
uuid
required

UUID of the loan being refinanced.

string
integer
Responses

401

Unauthenticated

422

Validation failed

502

Loan schedule service unavailable

Updated 24 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 24 days ago