Create Loan

post

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

Create new loans. Permission: Create Loans

Recent Requests

Log in to see full request history

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

csoBuyBackInterest

int32

Defaults to 0

csoBuyBackPrincipal

int32

Defaults to 0

csoLoanFee

int32

Defaults to 0

csoRateLoan

int32

Defaults to 0

csoRatePayment

int32

Defaults to 0

csoTargetApr

int32

Defaults to null

customerUuid

string

required

daysLate

int32

Defaults to 0

decisioningProvider

string

Defaults to null

deferredPayments

int32

Defaults to 0

denialReason

string

Defaults to null

deniedAt

date

Defaults to null

string date/time

desiredPrincipalAmount

int32

Defaults to 0

estimatedFundingOn

date

string date

externalId

string

Defaults to null

firstPaymentDate

date

string date

firstPaymentDay

int32

31 represents the last day of the month

fundedAt

string

Defaults to null

hasHardPrincipalPayments

boolean

interestRate

float

required

isAutoScheduled

boolean

Defaults to false

isContractViewable

boolean

Defaults to false

isFirstPaymentDefaulted

boolean

Defaults to false

isInterestAppliedAfterContract

boolean

Defaults to false

isSettlementEnabled

boolean

Defaults to false

lateFeeAmount

int32

lateFeeMax

int32

lateFeePercentage

int32

leadExternalId

string

Defaults to null

string as int

leadProvider

string

Defaults to null

leadType

string

enum

Allowed:

loanGroupUuid

string

required

loanTypeUuid

string

required

nextAutoScheduleDate

date

Defaults to null

numberOfPayments

int32

required

originationType

string

enum

Defaults to Refinanced

Allowed:

originalPrincipleAmount

float

required

originationFeePercentageWithApr

float

Defaults to null

originationFeeWithoutApr

float

Defaults to null

outstandingFee

int32

Defaults to 0

outstandingInterest

int32

Defaults to 0

outstandingPrincipal

int32

Defaults to 0

paidOffAt

date

Defaults to null

string date/time

pastDueBalance

float

Defaults to 0

paymentFrequency

string

enum

required

Allowed:

payOffAmount

float

Defaults to 0

refinanceAmount

int32

Defaults to 0

reversedAt

date

Defaults to null

string date/time

saleType

string

enum

Defaults to null

Allowed:

scheduleType

string

enum

Allowed:

secondPaymentDay

int32

31 represents the last day of the month

settledAt

date

Defaults to null

string date/time

settlementPercentage

float

Defaults to null

soldAt

date

Defaults to null

string date/time

soldTo

string

Defaults to null

thirdPartyFeesIntoPrincipal

int32

weekdayOfFirstPayment

string

enum

Allowed:

weekdayOfSecondPayment

string

enum

Allowed:

weekOfFirstPayment

int32

weekOfSecondPayment

int32

withdrawalReason

string

Defaults to null

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

writtenOffInterest

int32

Defaults to 0

writtenOffPrincipal

int32

Defaults to 0

writtenOffReason

string

Defaults to null

is_auto_draft_enabled

boolean

Defaults to false

Headers

Accept

string

required

Defaults to application/vnd.totality.v1+json

Content-Type

string

required

Defaults to application/json

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json