URL Expired

The URL for this request expired after 30 days.

Request Body Structure

account_id
string
required
ID of the Account

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*
ADD string

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.

interest_policies
object | null

• 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:
AM, AM_INTEREST

fee_policies
object | null
Policies for an origination fee related to this loan

fee_policies
object | null

• 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.

Allowed:
TRANSFER, OFFSET, CAPITALIZE

Preview
boolean
Flag to decide if this is a preview

Response Codes

``202 Loan/s restructuring successfully scheduled.

``303 See Other.

``401 Unauthorized.

``403 Forbidden.

``404 Account not found

``422 Invalid input

``429 Too many requests.

``default Unexpected Error.

Example Request (curl)

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/restructures/loans \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{

"interest_policies": {
    "interest_percent": 0,
    "is_limited_to_loan_duration": false
  },

"fee_policies": {
    "origination_fee_cents": 0,
    "origination_fee_percent": 0,
    "is_origination_fee_lesser_value": false,
    "is_origination_fee_amortized": false
  },

"interest_and_fee_handling": "CAPITALIZE"
}

'

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

303

Updated 6 months ago