Preview Cure Plan

Dry run - nothing is persisted. Legs are credited in order: sell (proceeds at the card's latest valuation reduce principal and the card leaves the collateral base), pay (reduces principal), add (a card on file for the borrower joins the collateral base). closedBySell + closedByPay + closedByAdd = closedAmount. Sale proceeds and the payment count only for the part the loan's own repayment allocation puts on principal - worked out by a dry run of the loan's transaction processor that saves nothing; the rest is reported as appliedToDueAmount. On some loans that includes scheduled interest or fees on the installments the payment prepays, not just amounts due today. payment.method and the template fields do not change the arithmetic. A plan that cannot be priced in full is rejected rather than priced in part, and sale proceeds above the loan's total outstanding are a 400 with the same error submit returns. An earlier cure plan's payment still processing does not fail the preview; it is reported as paymentInProcessing. Requires READ_COLLATERAL.

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

loan id.

Body Params

Body of both the preview and the submit. Every key is optional; submit additionally rejects a plan with no legs. Unknown keys at either level are rejected.

sellAssetIds
array of int64s

ACTIVE pledges on this loan to sell, by asset id. Positive whole numbers, no duplicates.

sellAssetIds
payment
object | null

Omit or null for a plan with no payment.

addCertNumbers
array of strings

Certificates on file for the borrower, pledged nowhere, with a valuation. Non-blank, at most 200 characters, no duplicates.

addCertNumbers
newCards
array of objects

Cards not on file yet, each the same item object as Pledge Collateral Item and parsed by the same rules. Submit locks and pledges them in the plan's transaction; the preview prices them at their value. A card can't appear twice, or both here and in addCertNumbers.

newCards
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json