Skip to main content
GET
Simular parcelas.
Retorna as opções de parcelamento disponíveis para o valor informado. A API identifica automaticamente o parceiro e a rede de lojas por meio do token de acesso. Você não precisa informar o identificador da rede.

Como o valor será calculado

Use o parâmetro tipoValorCalculo para definir o valor de referência da simulação.
Parâmetro opcional. Quando omitido, o padrão é 1 (valor bruto).
Para o mesmo estabelecimento, prazo e valor líquido, a parcela retornada aqui com tipoValorCalculo=2 é a mesma retornada por Simular repasse para o mesmo prazo.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Query Parameters

valorSolicitado
number<double>
required

Valor de referência para a simulação. Deve ser igual ou superior a R$ 250,00. O significado depende de tipoValorCalculo.

Required range: x >= 250
tipoValorCalculo
enum<integer>
default:1

Define o valor de referência do cálculo:

  • 1 — A partir do valor da venda. valorSolicitado representa o valor bruto da venda.
  • 2 — A partir do valor líquido. valorSolicitado representa o valor líquido que o estabelecimento deseja receber.

Opcional. Quando omitido, o padrão é 1 (valor bruto).

Available options:
1,
2

Response

Opções de parcelamento calculadas com sucesso.

valorTotalDebito
number<double>

Valor total que será pago pelo cliente.

prazo
integer<int32>

Quantidade de parcelas.

valorParcela
number<double>

Valor de cada parcela.