Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
loanAmount
number
required

Loan Amount ($)

Required range: 0 <= x <= 999999999
interestRate
number
required

Annual Interest Rate (%)

Required range: 0 <= x <= 100
tenure
number
required

Loan Tenure

Required range: 1 <= x <= 600
tenureUnit
enum<string>

Tenure Unit

Available options:
years,
months
calcMethod
enum<string>

Calculation Method

Available options:
reducing,
flat
extraMonthly
number

Monthly Extra Payment ($)

Required range: 0 <= x <= 999999999
lumpSum
number

One-time Lump Sum ($)

Required range: 0 <= x <= 999999999
lumpSumMonth
number

Lump Sum at Month #

Required range: 1 <= x <= 600
compAAmount
number

Loan A Amount ($)

Required range: 0 <= x <= 999999999
compARate
number

Loan A Rate (%)

Required range: 0 <= x <= 100
compATenure
number

Loan A Tenure

Required range: 1 <= x <= 600
compATenureUnit
enum<string>

Loan A Unit

Available options:
years,
months
compBAmount
number

Loan B Amount ($)

Required range: 0 <= x <= 999999999
compBRate
number

Loan B Rate (%)

Required range: 0 <= x <= 100
compBTenure
number

Loan B Tenure

Required range: 1 <= x <= 600
compBTenureUnit
enum<string>

Loan B Unit

Available options:
years,
months

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.