Run simulation

Simulate a financing to see the financing terms for a given input

You can fetch the financing terms available to your merchant account using the Get Financing Terms endpoint. These terms can be used validate simulation inputs.

Run Simulation

POST https://api.finove.com.br/api/v1/simulation/simulate-payment

Run the simulation for the parameters

Headers

Name	Type	Description
Authorization*	string	Access token received from Authentication API. Needs to be on format "Bearer <YOUR_ACCESS_TOKEN>"

Request Body

Name	Type	Description
amount*	number	Amount of the purchase in cents (R$ 1.000,99 should be submitted as 100099)
installmentsCount*	number	Number of installments
interestRate*	number	Monthly interest rate (in decimal - ex. 0.02 = 2%)
firstInstallmentDate*	string	Due date of the first installment (dd-mm-yyyy)
monthsUntilFirstPayment	number	Number of months until the first installment is due (defaults to 1)
merchantSubsidyRate	number	Rate of the subsidy to apply to the financing (in decimal - ex. 0.02 = 2%)
merchantSubsidyAmount	number	Amount of the subsidy to apply to the financing in cents (R$ 1.000,99 should be 100099)

200

{
   amount: 1000000,
   interestRate: 0.02,
   installmentAmount: 545000,
   cetMonthlyRate: 0.0189,
   cetAnnualRate: 0.2512,
   totalAmount: 1090000,
   taxAmount: 50000,
   otherTaxAmount: 0,
   interestAmount: 40000,
   costsAmount: 0,
   installmentsCount: 2,
   firstInstallmentDate: "2021-08-26T13:52:13.000Z",
   installments: [
      {
         number: 1,
         date: "2021-08-26T13:52:13.000Z",
         amount: 545000,
         costs: 0,
         interest: 20000,
         remainingPrincipal: 505000
      },
      {
         number: 2,
         date: "2021-09-26T13:52:13.000Z",
         amount: 545000,
         costs: 0,
         interest: 20000,
         remainingPrincipal: 0
      }],
   merchantSubsidyType: 'none',
   merchantSubsidyRate: 0,
   merchantSubsidyAmount: 0,
   originalInterestRate: 0.02,
   merchantTotalAmount: 1000000
}

Response

Attribute	Type	Description
Attribute	Type	Description
installmentAmount	number	Value of each installment in cents (R$ 1.000,99 is represented as 100099)
cetMonthlyRate	number	Monthly CET (Total Effective Cost) rate (in decimal - ex. 0.02 = 2%)
cetAnnualRate	number	Annual CET (Total Effective Cost) rate (in decimal - ex. 0.02 = 2%)
totalAmount	number	Total amount (principal + interest + taxes + costs) that will be paid (in cents - R$ 1.000,99 is represented as 100099)
taxAmount	number	Total tax that will be paid (in cents - R$ 1.000,99 is represented as 100099)
otherTaxAmount	number	Any additional special taxes (in cents - R$ 1.000,99 is represented as 100099)
interestAmount	number	Total interest that will be paid (in cents - R$ 1.000,99 is represented as 100099)
costsAmount	number	Total costs that will be paid (in cents - R$ 1.000,99 is represented as 100099)
installmentsCount	number	Number of installments
firstInstallmentDate	date	Date when first installment will be due
installments	array	array with information for each installment:
installments.number	number	number of the installment (1st, 2nd, 3rd,...)
installments.date	date	Date when the installment will be due
installments.amount	number	Amount to be paid for that installment (in cents - R$ 1.000,99 is represented as 100099)
installments.cost	number	Amount of this installment that corresponds to costs (in cents - R$ 1.000,99 is represented as 100099)
installments.interest	number	Amount of this installment that corresponds to interests (in cents - R$ 1.000,99 is represented as 100099)
installments.remainingPrincipal	number	Remaining principal after the payment of this installment (in cents - R$ 1.000,99 is represented as 100099)
merchantSubsidyType	enum	The type of subsidy when running the simulation. 'none', 'rate', or 'amount'
merchantSubsidyAmount	number	Value of merchant subsidy in cents (automatically calculated if merchantSubsidyRate is provided)
merchantSubsidyRate	number	Rate of merchant subsidy (automatically calculated if merchantSubsidyAmount is provided) (in decimal - ex. 0.02 = 2%)
amount	number	Total amount requested for the simulation (in cents - R$ 1.000,99 is represented as 100099)
interestRate	number	Total interest rate applied in the simulation (in decimal - ex. 0.02 = 2%)
originalInterestRate	number	Customer's interest rate before subsidy (in decimal - ex. 0.02 = 2%)
merchantTotalAmount	number	Amount that will be paid to merchant (amount - merchantFeeAmount)