API Reference

Create Payment Plan

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

Create a new payment plan on an active loan and generate the scheduled payments for the plan. Existing scheduled payments on the loan that have no associated processed payment are removed, and the loan is taken off auto-scheduling. If the lender setting allowOnlySinglePaymentPlan is enabled, the request will be rejected when an active payment plan already exists. Permission: Create Payment Plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The UUID of the active loan to attach the payment plan to.

Body Params
integer | null

ID of the user (collector) the plan should be assigned to. Must reference an existing user.

string | null
enum

How the customer was contacted to set up the plan. One of: Automation, Email, Phone, SMS, Self-Service Portal, Webchat, Other.

Allowed:
integer | null

Number of days in each period. Required when paymentFrequency is days. Must be greater than 0.

integer | null

Day of the month for the first payment when scheduleType is Day-Based. Use 1-31 (31 represents the last day of the month).

date
required

Date of the first scheduled payment in YYYY-MM-DD format. Must be today or later.

boolean | null

Whether this plan only covers a portion of the loan balance. When true, totalPlanAmount is required and must not exceed the loan balance.

integer
required

Number of days to shift a scheduled payment when it falls on a holiday. Use 0 to leave the payment in place. Negative values shift earlier; positive values shift later.

integer
required

Number of days to shift a scheduled payment when it falls on a weekend. Use 0 to leave the payment in place. Negative values shift earlier; positive values shift later.

integer | null

Total number of payments in the plan. Required when paymentArrangementType is Payment Number Based. Must be greater than 0.

integer | null

Per-payment amount in cents. Required when paymentArrangementType is Payment Amount Based. Must be greater than 0. Defaults to the loan's first amortization schedule amount when omitted.

string
enum
required

How the payment schedule is generated. One of: Payment Amount Based, Payment Number Based, Custom Payment Schedule.

Allowed:
string
enum
required

Frequency of payments. One of: days, weekly, bi-weekly, semi-monthly, monthly.

Allowed:
schedule
array of objects

Required when paymentArrangementType is Custom Payment Schedule. Each entry defines a single payment in the custom schedule.

schedule
string | null
enum

Schedule rule type used when generating semi-monthly schedules. One of: Day-Based, Weekday-Based.

Allowed:
integer | null

Day of the month for the second payment when scheduleType is Day-Based and frequency is semi-monthly. Use 1-31.

integer | null

Total dollar amount the partial plan should cover, in cents. Required when isPartialPaymentPlan is true. Must not exceed the loan balance.

string | null

Weekday name for the first payment when scheduleType is Weekday-Based (e.g., Monday).

string | null

Weekday name for the second payment when scheduleType is Weekday-Based and frequency is semi-monthly.

integer | null

Week of the month (1-5) for the first payment when scheduleType is Weekday-Based.

integer | null

Week of the month (1-5) for the second payment when scheduleType is Weekday-Based and frequency is semi-monthly.

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/vnd.totality.v1+json.

string
required
Defaults to application/json

Must be application/json.

Responses

404

Resource not found

500

Internal server error

Updated 12 days ago

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

Updated 12 days ago