Create Loan

post

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

Create new loan. Permission: Create Loans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

approvedAt

date

Defaults to null

string date/time

becameEligibleForRefinanceOn

date

Defaults to null

string date

csoBuyBackDate

date

Defaults to null

string date

csoBuyBackFees

int32

Defaults to 0

CSO buy-back fees in cents.

csoBuyBackInterest

int32

Defaults to 0

CSO buy-back interest in cents.

csoBuyBackPrincipal

int32

Defaults to 0

CSO buy-back principal in cents.

csoLoanFee

int32

Defaults to 0

CSO loan fee in cents.

csoRateLoan

int32

Defaults to 0

CSO rate for the loan.

csoRatePayment

int32

Defaults to 0

CSO rate per payment.

csoTargetApr

int32

Defaults to null

Target APR for CSO loans.

customerUuid

string

required

UUID of the associated customer.

daysLate

int32

Defaults to 0

Number of days the loan is past due.

decisioningProvider

string

Defaults to null

Decisioning/underwriting provider used.

deferredPayments

int32

Defaults to 0

Number of deferred payments.

denialReason

string

Defaults to null

Reason the loan was denied.

deniedAt

date

Defaults to null

string date/time

desiredPrincipalAmount

int32

Defaults to 0

Requested principal amount in cents.

estimatedFundingOn

date

string date

externalId

string

Defaults to null

External system identifier for cross-referencing.

firstPaymentDate

date

string date

firstPaymentDay

int32

31 represents the last day of the month

fundedAt

string

Defaults to null

Timestamp when the loan was funded (ISO 8601).

hasHardPrincipalPayments

boolean

Whether the loan has fixed principal payments.

interestRate

float

required

Annual interest rate as a percentage.

isAutoScheduled

boolean

Defaults to false

Whether this was automatically scheduled.

isContractViewable

boolean

Defaults to false

Whether the contract is viewable.

isFirstPaymentDefaulted

boolean

Defaults to false

Whether the first payment was defaulted.

isInterestAppliedAfterContract

boolean

Defaults to false

Whether interest accrues after contract signing.

isSettlementEnabled

boolean

Defaults to false

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

Defaults to null

string as int

leadProvider

string

Defaults to null

Lead provider name.

leadType

string

enum

Type of lead that originated the loan.

Allowed:

loanGroupUuid

string

required

UUID of the loan group.

loanTypeUuid

string

required

UUID of the loan type.

nextAutoScheduleDate

date

Defaults to null

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

numberOfPayments

int32

required

Total number of scheduled payments.

originationType

string

enum

Defaults to Refinanced

How the loan originated.

Allowed:

originalPrincipleAmount

float

required

Original principal loan amount in cents.

originationFeePercentageWithApr

float

Defaults to null

Origination fee percentage included in APR.

originationFeeWithoutApr

float

Defaults to null

Origination fee not included in APR.

outstandingFee

int32

Defaults to 0

Outstanding fee balance in cents.

outstandingInterest

int32

Defaults to 0

Outstanding interest balance in cents.

outstandingPrincipal

int32

Defaults to 0

Outstanding principal balance in cents.

paidOffAt

date

Defaults to null

string date/time

pastDueBalance

float

Defaults to 0

Past due balance.

paymentFrequency

string

enum

required

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

Allowed:

payOffAmount

float

Defaults to 0

Pay off amount.

refinanceAmount

int32

Defaults to 0

Refinance amount in cents.

reversedAt

date

Defaults to null

string date/time

saleType

string

enum

Defaults to null

Type of loan sale.

Allowed:

scheduleType

string

enum

Payment schedule type.

Allowed:

secondPaymentDay

int32

31 represents the last day of the month

settledAt

date

Defaults to null

string date/time

settlementPercentage

float

Defaults to null

Settlement percentage.

soldAt

date

Defaults to null

string date/time

soldTo

string

Defaults to null

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

Defaults to null

Reason the loan was withdrawn.

withdrawnAt

date

Defaults to null

string date/time

workedAt

date

Defaults to null

string date/time

writtenOffAt

date

Defaults to null

string date/time

writtenOffFees

int32

Defaults to 0

Written-off fees amount in cents.

writtenOffInterest

int32

Defaults to 0

Written-off interest amount in cents.

writtenOffPrincipal

int32

Defaults to 0

Written-off principal amount in cents.

writtenOffReason

string

Defaults to null

Reason the loan was written off.

is_auto_draft_enabled

boolean

Defaults to false

Is_auto_draft_enabled.

Headers

string

required

Defaults to application/vnd.totality.v1+json

Must be application/json.

Content-Type

string

required

Defaults to application/json

Must be application/json.

Responses

200Successful response

400400

401401

403403

422422

500500