GET api/Retailer/FinanceCalculator/{rateCardProductId}/{price}/{deposit}

Get finance calculator, based on a chosen by the user rate card product, price and deposit. It provides information about the monthly payment, monthly interest rate, total interest payable, APR, etc. which the user can use for launching a loan application.

Request Information

URI Parameters

Name	Type	Additional information
rateCardProductId	globally unique identifier	Required
price	decimal number	Required
deposit	decimal number	Required

Body Parameters

None.

Response Information

Resource Description

RetailerFinanceCalculatorModel

Name	Type	Additional information
RateCardProductId	globally unique identifier	None.
RateCardProductName	string	None.
Price	decimal number	None.
Deposit	decimal number	None.
LoanValue	decimal number	None.
MonthlyInterestRate	decimal number	None.
MonthlyPayment	decimal number	None.
APR	decimal number	None.
TotalInterestPayable	decimal number	None.
Term	integer	None.
DeferredTerm	integer	None.
TotalTerm	integer	None.
CustomerAdminFee	decimal number	None.
AnnualInterestRate	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "RateCardProductId": "5759bf9b-e279-42a4-bf0a-1f04a5c209d9",
  "RateCardProductName": "sample string 2",
  "Price": 1.0,
  "Deposit": 1.0,
  "LoanValue": 1.0,
  "MonthlyInterestRate": 1.1,
  "MonthlyPayment": 1.0,
  "APR": 1.1,
  "TotalInterestPayable": 1.0,
  "Term": 3,
  "DeferredTerm": 4,
  "TotalTerm": 5,
  "CustomerAdminFee": 1.0,
  "AnnualInterestRate": 1.0
}

text/html

Sample:

{"RateCardProductId":"5759bf9b-e279-42a4-bf0a-1f04a5c209d9","RateCardProductName":"sample string 2","Price":1.0,"Deposit":1.0,"LoanValue":1.0,"MonthlyInterestRate":1.1,"MonthlyPayment":1.0,"APR":1.1,"TotalInterestPayable":1.0,"Term":3,"DeferredTerm":4,"TotalTerm":5,"CustomerAdminFee":1.0,"AnnualInterestRate":1.0}

application/xml, text/xml

Sample:

<RetailerFinanceCalculatorModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.RetailerFinanceCalculatorResponses">
  <APR>1.1</APR>
  <AnnualInterestRate>1</AnnualInterestRate>
  <CustomerAdminFee>1</CustomerAdminFee>
  <DeferredTerm>4</DeferredTerm>
  <Deposit>1</Deposit>
  <LoanValue>1</LoanValue>
  <MonthlyInterestRate>1.1</MonthlyInterestRate>
  <MonthlyPayment>1</MonthlyPayment>
  <Price>1</Price>
  <RateCardProductId>5759bf9b-e279-42a4-bf0a-1f04a5c209d9</RateCardProductId>
  <RateCardProductName>sample string 2</RateCardProductName>
  <Term>3</Term>
  <TotalInterestPayable>1</TotalInterestPayable>
  <TotalTerm>5</TotalTerm>
</RetailerFinanceCalculatorModel>