Pular para o conteúdo principal

Calcular Valor da Parcela (Com IOF)

Segurança​

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos​

CampoTipoDescrição
interest_ratenumberValor da taxa de juros. No formato "0.0000"
number_of_paymentsnumberNumero de pagamentos
present_valuenumberValor presente

Requisição​

POST https://api-sandbox.catalisa.com.br/calc-engine/api/loan-payment-calculator/calculations

Parâmetros​

Sem parâmetros

Cabeçalhos​

NomeValor
AuthorizationBearer <token>
Content-Typeapplication/json

Exemplo de Requisição​

Corpo da Requisição​

{
"data": {
"type": "calculations",
"attributes": {
"interest_rate": 0.0465,
"number_of_payments": 6,
"present_value": 10130.31
}
}
}

Respostas​

CódigoDescrição
201Criado com sucesso. Retorna os dados calculados.
401Não autorizado

Exemplo de uso​

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
data: {
type: "calculations",
attributes: {
interest_rate: 0.0465,
number_of_payments: 6,
present_value: 10130.31
}
}
});

const requestOptions = {
method: "POST",
headers: headers,
body: body,
};

const response = await fetch(
"https://api-sandbox.catalisa.com.br/calc-engine/api/loan-payment-calculator/calculations",
requestOptions
);
const data = await response.json();
console.log(data);

Exemplo de Sucesso​

{
"data": {
"id": "f1595235-34c4-4771-a913-1d627e03a321",
"type": "calculations",
"attributes": {
"payment": 1973.56
}
}
}