Skip to main content
GET
Simular repasse.
Calcula os valores da venda para o estabelecimento e para o cliente. 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.

Quem paga os juros

Use o parâmetro modeloJuros para definir quem será responsável pelos juros.
Por enquanto, use apenas modeloJuros=1. A opção 2 ainda não está disponível.

Como o valor será calculado

Use o parâmetro tipoValorCalculo para definir o valor de referência da simulação.
Envie os valores numéricos dos enums nos query parameters. Por exemplo: modeloJuros=1&tipoValorCalculo=1.

Prazo

O parâmetro prazo deve estar dentro do intervalo configurado para a rede de lojas do parceiro. Um prazo fora desse intervalo retorna 400 com o erro Order.TermOutOfRange, no mesmo formato usado para os demais erros de validação da API (tipo, titulo, status, detalhe, erros).

Authorizations

Authorization
string
header
required

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

Query Parameters

valor
number<double>
required

Valor de referência da simulação. O significado depende de tipoValorCalculo.

prazo
integer<int32>
required

Quantidade de parcelas da simulação. Deve estar dentro do intervalo de prazos configurado para a rede de lojas do parceiro. Fora desse intervalo, a API retorna 400 com o erro Order.TermOutOfRange.

Required range: x >= 1
modeloJuros
enum<integer>
required

Define quem paga os juros. Por enquanto, use apenas 1.

  • 1 — Cliente (disponível).
  • 2 — Estabelecimento (em breve; ainda não disponível).
Available options:
1
tipoValorCalculo
enum<integer>
required

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

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

Response

Valores calculados com sucesso.

valoresEstabelecimento
object
valoresCliente
object