Calculate loan terms preview

Calculate a preview of loan terms (payment amounts, fees, etc.) for a given program without creating an application or offer.

    This is a dry-run calculation that uses Canopy's amortization API to ensure the
    calculated values match what would actually be charged if the loan were originated.

    **Request parameters:**
    - `requested_loan_amount` (required): The principal amount to calculate terms for
    - `requested_loan_term_days` (optional): Term in days. Defaults to program's max_term_days
    - `requested_apr` (optional): APR to use. Defaults to program's max_apr

    All requested values must be within the program's configured bounds.
Path Params
uuid
required
Body Params

Request schema for calculating a loan preview/dry-run.

This allows clients to preview loan terms (payment amounts, fees, etc.) without creating an application or offer.

required

The principal loan amount to calculate terms for

The loan term in days. If not provided, uses program's max_term_days. Must be divisible by remittance frequency.

≥ 0

The APR to use for calculation. If not provided, uses program's max_apr.

Headers
Responses

401

Unauthorized

403

Forbidden

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