Update Loan Information

patch

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

Update information on a non-approved loan. The funded amount (originalPrincipleAmount and refinanceAmount) is immutable once the loan has been funded; an update that would change it is rejected with a 409 and the loan is left unchanged. The funding date (fundedAt) cannot be cleared on a funded loan for the same reason. Permission: Update Loans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

loanUuid

string

required

Update information on a non-approved loan.

Body Params

approvedAt

date

string date/time

autoSchedulePaymentAmount

int32

Auto-scheduled payment amount in cents.

becameEligibleForRefinanceOn

date

string date

csoBuyBackDate

date

string date

csoBuyBackFees

int32

CSO buy-back fees in cents.

csoBuyBackInterest

int32

CSO buy-back interest in cents.

csoBuyBackPrincipal

int32

CSO buy-back principal in cents.

csoRateLoan

int32

CSO rate for the loan.

csoRatePayment

int32

CSO rate per payment.

csoTargetApr

int32

Target APR for CSO loans.

customFieldData

object

Loan-level custom fields, keyed by the custom field's name. Values are typed per each field's definition (string, number, boolean, date, or array for multi-select). Discover available fields via GET /api/custom-fields?context=Loan. On POST/PATCH this object is additive and optional; on PATCH only the supplied keys are updated.

daysLate

int32

Number of days the loan is past due.

decisioningProvider

string

Decisioning/underwriting provider used.

deferredPayments

int32

Number of deferred payments.

denialReason

string

Reason the loan was denied.

deniedAt

date

string date/time

desiredPrincipalAmount

int32

Requested principal amount in cents.

downPaymentAmount

int32

Down payment recorded on the loan, in cents. Recorded for reference only; does not reduce the financed principal.

estimatedFundingOn

date

string date

externalId

string

External system identifier for cross-referencing.

firstPaymentDate

date

string date

firstPaymentDay

int32

31 represents the last day of the month

fundedAt

string

Timestamp when the loan was funded (ISO 8601).

hasHardPrincipalPayments

boolean

Whether the loan has fixed principal payments.

interestRate

float

Annual interest rate as a percentage.

isAutoScheduled

boolean

Whether this was automatically scheduled.

isContractViewable

boolean

Whether the contract is viewable.

isFirstPaymentDefaulted

boolean

Whether the first payment was defaulted.

isInterestAppliedAfterContract

boolean

Whether interest accrues after contract signing.

isSettlementEnabled

boolean

Is settlement enabled.

lateFeeAmount

int32

Late fee fixed amount in cents.

lateFeeMax

int32

Maximum late fee amount in cents.

lateFeePercentage

int32

Late fee as a percentage of payment.

leadExternalId

string

string as int. Repointing this to an id already assigned to a DIFFERENT customer's loan is rejected with 422; re-sending the loan's own id or reuse within the same customer is accepted.

leadProvider

string

Lead provider name.

leadType

string

enum

Type of lead that originated the loan.

Allowed:

loanGroupUuid

string

UUID of the loan group.

loanTypeUuid

string

UUID of the loan type.

movePaymentDaysHoliday

int32

Holiday payment adjustment (-1=before, 0=stay, 1=after).

nextAutoScheduleDate

date

Next auto-schedule date (YYYY-MM-DD).

numberOfPayments

int32

required

Total number of scheduled payments.

originalPrincipleAmount

float

required

Original principal loan amount in cents.

originationFeePercentageWithApr

float

Origination fee percentage included in APR.

originationFeeWithoutApr

float

Origination fee not included in APR.

originationType

string

enum

How the loan originated.

Allowed:

outstandingFee

int32

Outstanding fee balance in cents.

outstandingInterest

int32

Outstanding interest balance in cents.

outstandingPrincipal

int32

Outstanding principal balance in cents.

paidOffAt

date

string date/time

pastDueBalance

int32

Past due balance.

paymentFrequency

string

enum

How often payments are made (Weekly, Bi-Weekly, Monthly, Semi-Monthly).

Allowed:

payOffAmount

int32

Pay off amount.

refinanceAmount

int32

Refinance amount in cents.

reversedAt

date

string date/time

saleType

string

enum

Type of loan sale.

Allowed:

scheduleType

string

enum

Payment schedule type.

Allowed:

secondPaymentDay

int32

31 represents the last day of the month

settledAt

date

string date/time

settlementPercentage

float

Settlement percentage.

soldAt

date

string date/time

soldTo

string

Entity the loan was sold to.

thirdPartyFeesIntoPrincipal

int32

Third-party fees rolled into principal in cents.

weekdayOfFirstPayment

string

enum

Day of week for first payment.

Allowed:

weekdayOfSecondPayment

string

enum

Day of week for second payment (semi-monthly).

Allowed:

weekOfFirstPayment

int32

Week of first payment.

weekOfSecondPayment

int32

Week of second payment.

withdrawalReason

string

Reason the loan was withdrawn.

withdrawnAt

date

string date/time

workedAt

date

string date/time

writtenOffAt

date

string date/time

writtenOffFees

int32

Written-off fees amount in cents.

writtenOffInterest

int32

Written-off interest amount in cents.

writtenOffPrincipal

int32

Written-off principal amount in cents.

writtenOffReason

string

Reason the loan was written off.

is_auto_draft_enabled

boolean

Is_auto_draft_enabled.

Responses

204204

400400

401401

403403

409409

422Validation error - including a leadExternalId already assigned to a different applicant.

500500