API Reference

Create Loan

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

Create new loan. Permission: Create Loans

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

string date

date
Defaults to null

string date/time

date
Defaults to null

string date

date
Defaults to null

string date

int32
Defaults to 0

CSO buy-back fees in cents.

int32
Defaults to 0

CSO buy-back interest in cents.

int32
Defaults to 0

CSO buy-back principal in cents.

int32
Defaults to 0

CSO loan fee in cents.

int32
Defaults to 0

CSO rate for the loan.

int32
Defaults to 0

CSO rate per payment.

int32
Defaults to null

Target APR for CSO loans.

string
required

UUID of the associated customer.

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. Responses list every configured Loan custom field; a field with no value is null.

int32
Defaults to 0

Number of days the loan is past due.

string
Defaults to null

Decisioning/underwriting provider used.

int32
Defaults to 0

Number of deferred payments.

string
Defaults to null

Reason the loan was denied.

date
Defaults to null

string date/time

int32
Defaults to 0

Requested principal amount in cents.

int32
Defaults to 0

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

date

string date

string
Defaults to null

External system identifier for cross-referencing.

date

string date

int32

31 represents the last day of the month

string
Defaults to null

Timestamp when the loan was funded (ISO 8601).

boolean

Whether the loan has fixed principal payments.

float
required

Annual interest rate as a percentage.

boolean
Defaults to false

Whether this was automatically scheduled.

boolean
Defaults to false

Whether the contract is viewable.

boolean
Defaults to false

Whether the first payment was defaulted.

boolean
Defaults to false

Whether interest accrues after contract signing.

boolean
Defaults to false

Is settlement enabled.

int32

Late fee fixed amount in cents.

int32

Maximum late fee amount in cents.

int32

Late fee as a percentage of payment.

string
Defaults to null

string as int. Provider's unique id for the lead that originated this loan. An id already assigned to a DIFFERENT customer's loan is rejected with 422; reuse by the same customer is accepted.

string
Defaults to null

Lead provider name.

string
enum

Type of lead that originated the loan.

Allowed:
string
required

UUID of the loan group.

string
required

UUID of the loan type.

date
Defaults to null

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

int32
required

Total number of scheduled payments.

string
enum
Defaults to Refinanced

How the loan originated.

Allowed:
float
required

Original principal loan amount in cents.

float
Defaults to null

Origination fee percentage included in APR.

float
Defaults to null

Origination fee not included in APR.

int32
Defaults to 0

Outstanding fee balance in cents.

int32
Defaults to 0

Outstanding interest balance in cents.

int32
Defaults to 0

Outstanding principal balance in cents.

date
Defaults to null

string date/time

float
Defaults to 0

The total dollar amount that is currently past due on this loan. An installment due today is counted. Capped at the loan's payoff amount, and zero for inactive loans.

string
enum
required

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

Allowed:
float
Defaults to 0

Pay off amount.

int32 | null

System-recommended maximum principal amount in cents. When set, the loan principal may not exceed it without an override.

int32
Defaults to 0

Refinance amount in cents.

date
Defaults to null

string date/time

string
enum
Defaults to null

Type of loan sale.

Allowed:
string
enum

Payment schedule type.

Allowed:
int32

31 represents the last day of the month

date
Defaults to null

string date/time

float
Defaults to null

Settlement percentage.

date
Defaults to null

string date/time

string
Defaults to null

Entity the loan was sold to.

int32

Third-party fees rolled into principal in cents.

boolean

Use acquiredDate as the origination reference for the days-late calculation.

string
enum

Day of week for first payment.

Allowed:
string
enum

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

Allowed:
int32

Week of first payment.

int32

Week of second payment.

string
Defaults to null

Reason the loan was withdrawn.

date
Defaults to null

string date/time

date
Defaults to null

string date/time

date
Defaults to null

string date/time

int32
Defaults to 0

Written-off fees amount in cents.

int32
Defaults to 0

Written-off interest amount in cents.

int32
Defaults to 0

Written-off principal amount in cents.

string
Defaults to null

Reason the loan was written off.

boolean
Defaults to false

Is_auto_draft_enabled.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago

Did this page help you?