Com comissão

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

Campo	Tipo	Descrição
interest_rate	number	Taxa de juros. No formato "0.0000"
commission_rate	number	Taxa de commissão
grace_period	number	Período de carência
number_of_payments	number	Número de pagamentos

Requisição

POST https://api-sandbox.catalisa.com.br/calc-engine/api/loan-coefficient-calculator/calculations JWT scope: calculations-engine/calculate

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
    "data": {
        "type": "calculations",
        "attributes": {
            "interest_rate": 0.0465,
            "commission_rate": 0.87,
            "grace_period": 30,
            "number_of_payments": 12
        }
    }
}

Respostas

Código	Descrição
201	Criado com sucesso. Retorna os dados da tabela de amortização.
401	Não autorizado

Exemplo de uso

Javascript

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,
            commission_rate: 0.87,
            grace_period: 30,
            number_of_payments: 12
        }
    }
});

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

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

CURL

curl --location 'https://api-sandbox.catalisa.com.br/calc-engine/api/loan-coefficient-calculator/calculations' \
--header 'Authorization: Bearer <token>' \
--data '{
    "data": {
        "type": "calculations",
        "attributes": {
            "interest_rate": 0.0465,
            "commission_rate": 0.87,
            "grace_period": 30,
            "number_of_payments": 12
        }
    }
}'

Exemplo de Sucesso

{
  "data": {
    "id": "74056f90-db2f-42ea-b514-0001197d12b0",
    "type": "calculations",
    "attributes": {
      "loan_coefficient": 0.20683927132
    }
  }
}