API Reference

Create Promise to Pay Plan

post
https://embarc-api-qa.lendapi.com/embarc-core/api/v1/loans//promises-to-pay

Create a promise-to-pay plan. Only one ACTIVE plan can exist per loan.

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

The unique identifier of the loan.

Regex: ^\d+$

Example: 2201

Body Params
date
required
Defaults to 2025-11-26

First installment date.

Example: 2025-11-26

double
Defaults to 1200

Total promise amount (optional for BESPOKE).

Example: 1200.00

string
enum
required
Defaults to WEEKLY

Payment frequency (WEEKLY, MONTHLY, SEMI_MONTHLY, BESPOKE, ONE_TIME).

Example: WEEKLY

Allowed:
integer
Defaults to 1

Repeat interval for WEEKLY/MONTHLY schedules.

Example: 2

integer
Defaults to 6

Number of installments for generated schedules.

Example: 6

integer
Defaults to 22

Second payment day for SEMI_MONTHLY plans.

Example: 22

bespokeSchedule
array of objects

Bespoke installments when frequency is BESPOKE.

bespokeSchedule
string
Defaults to Borrower promises to pay every other Wednesday.

Optional note recorded with the plan.

Example: Borrower promises to pay every other Wednesday.

Headers
string
required
Defaults to default

Tenant routing identifier for Embarc.

Example: default

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?