Skip to main content
PUT
Update loan terms

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId
integer
required

The financial account ID

Body

application/json
kind
enum<string>

What kind of debt a manual loan account is. Drives the default account type when the loan is created in a destination.

Available options:
MORTGAGE,
STUDENT,
AUTO,
PERSONAL,
OTHER
repayment_type
enum<string>

How the loan is paid down. Only the months-remaining estimate depends on it; the interest, fee and payment split never does.

Available options:
ANNUITY,
SERIAL,
INTEREST_ONLY
fee_per_payment
number

Applies to payments from now on.

Required range: x >= 0
day_count
enum<string>

Applies to accruals from now on.

Available options:
ACT_365,
ACT_360,
THIRTY_360
original_amount
number | null
Required range: x >= 0
start_date
string<date-time> | null
term_months
integer | null
Required range: 1 <= x <= 600
paying_financial_account_id
integer | null

A bank account of the loan's owner that pays the loan; null switches to schedule mode (set schedule).

schedule
object | null

Schedule mode; null turns it off (set paying_financial_account_id).

Response

message
string
required
Allowed value: "Loan terms updated."
data
LoanTermsResource · object
required