Calculate the amortization schedule for a specific loan

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Amortization Schedule Calculation Inputs

Field Type Requirement Description
product_id string required The ID of the product to which the loan belongs.
principal_balance_cents integer required The loan amount (in cents) excluding deferred interest and amortized fees.
deferred_interest_balance_cents integer Defaults to 0 The amount of deferred interest (in cents) to be amortized in equal monthly payments. Interest will not be charged on this balance.
am_fee_balance_cents integer Defaults to 0 The amount of fees (in cents) to be amortized in equal monthly payments. Interest will not be charged on this balance.
am_len integer required Amortization length in number of cycles (e.g. am_len: 3 and cycle_interval: 1 month would amortize 3 periods of 1 month each for a total repayment across 3 months).
first_cycle_interval string The duration of the first cycle. If not provided, defaults to the cycle_interval specified in the product configuration.
effective_at date-time required The date of the creation of the account.
interest_rate number required The yearly interest rate to be charged on the loan, as a percent (i.e. 8.76 for an 8.76% yearly interest rate). Defaults to 0 if not provided.
min_pay_type string enum Defaults to AM. The type of minimum payment to be calculated. AM is the default. Allowed values: AM, AM_INTEREST.

Responses

Example cURL Request

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/amortization_schedule \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "deferred_interest_balance_cents": 0,
  "am_fee_balance_cents": 0,
  "interest_rate": 0,
  "min_pay_type": "AM"
}
'

Notes

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