Sales simulator

Endpoint responsible for simulating sale conditions based on the informed amount, number of installments, and desired payment methods.

This request is useful for integrations that need to present the user with installment estimates or commercial conditions in advance, before the charge is actually created.


Main request parameters

  • value — Total amount of the installment plan or charge
  • installmentCount — Number of installments considered in the simulation
  • billingTypes — List of payment methods that should be evaluated in the simulation

When to use this endpoint

This endpoint is commonly used in:

  • checkout simulators
  • commercial screens
  • interfaces that present terms before contracting
  • prior installment validation
Body Params
number
required

Total installment or billing amount

int32

Number of installments

billingTypes
array of objects
required

Form of payment

billingTypes*
Responses

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