Initiates the restructuring of one or multiple loans

post

https://Contact sales to enable your sandbox/accounts/{account_id}/line_items/restructures/loans

This operation results in a single new loan, configured as per the setting provided in the request payload.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

ID of the Account

Body Params

Body of request to restructure one or multiple loans

restructured_loans_ids

array of strings

required

length ≤ 10

The IDs of the loans to be restructured

restructured_loans_ids*

line_item_id

string

^(?!can_).*$

The ID associated to be with the restructured loan for future requests. If not provided on line item creation, Canopy will generate this field.

description

string

A description of this particular line item if any.

interest_policies

object | null

Policies for interest on this new loan. If none are specified, the account interest policies will be applied.

am_len

integer

required

The number of cycles after restructuring over which the loan amortizes. This property is mandatory if restructuring multiple loans.

min_pay_type

string | null

enum

Only applicable to LOAN type line_items. Optionally override the min_pay_type for this loan. For the minimum payment to include principal and interest each cycle, use AM. For the minimum payment to include only accrued interest for all cycles except the final cycle, and all principal and accrued interest in the final cycle, use AM_INTEREST. If not included, the loan will use the Account's min_pay_type value.

Allowed:

fee_policies

object | null

Policies for an origination fee related to this loan

external_fields

array,null | object,null

notes

string

Any notes associated to this new loan.

interest_and_fee_handling

string

enum

required

The strategy to handle outstanding interest and fee balances on the original loans.
TRANSFER: the outstanding interest and fees balances are transferred to the newly restructured loan.
OFFSET: the system will create offset transaction records for each interest and fee line item on the original loans.
CAPITALIZE: the outstanding interest and fees balances are capitalized into the loan(s) which will then be restructured.

Allowed:

Headers

Preview

boolean

Flag to decide if this is a preview

Responses

202

Loan/s restructuring successfully scheduled.

401

Unauthorized.

403

Forbidden.

404

Account not found

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

303See Other.