API Reference

Create Refinance Loan

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

Create a refinance loan from an existing loan. The new loan's principal, interest rate, and number of payments are derived server-side from the referenced loan's group settings (refinance offer source, gamification tier rate, loan type APR options). 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. refinanceAmount and refinanceFunded are always derived. The old loan is back-linked to the new one. Dispatches RefinancedLoanCreatedEvent.

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

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

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).

uuid
required
Responses

401

Unauthenticated

422

Validation failed

Updated 24 days ago

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

Updated 24 days ago