Condições do Crédito Aprovado (Credit Approved)

Essa seção descreve como é o funcionamento do endpoint /list-credit-approved, que traz as condições do crédito aprovado com base no ID da proposta (proposalId). Para efetuar essa consulta é necessário ter uma proposta criada e ter recebido o identificador (proposal_id) dessa solicitação.

Como consultar o detalhamento do crédito aprovado

As informações enviadas devem seguir o request headers e request body a seguir:

Request HTTP GET

Tipo da Requisição	URL	Exemplo
`GET`	`{{url_base}}/proposals/:proposalId/conditions/list-credit-approved`	https://stg-api.creditas.io/b2b/proposals/:proposalId/conditions/list-credit-approved

Request Headers

Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.\

Request Path com Id da proposta

Path	Obrigatório	Descrição
`:proposalId`	Sim	Id da proposta que deseja consultar. Ex: `B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0` O id deve ser preenchido como path da url. Ex: https://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/conditions/credit-approved

Path

Obrigatório

Descrição

:proposalId

Sim

Id da proposta que deseja consultar.
Ex: B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0

O id deve ser preenchido como path da url.
Ex: https://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/conditions/credit-approved

Exemplo de Request e Response

curl --location 'https://stg-api.creditas.io/b2b/proposals/B2B-A78CE056-5A23-4BDC-B949-91BA827CBE7F/conditions/list-credit-approved' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer <TOKEN>'

[
  {
    "approvedAt": "2025-10-30",
    "application": {
      "installment": {
        "value": { "currency": "BRL", "amount": 8828.29 },
        "maturity": 120
      },
      "approvedCredit": { "currency": "BRL", "amount": 438896.99 },
      "netValues": { "currency": "BRL", "amount": 1031613.07 },
      "iof": { "currency": "BRL", "amount": 14628.13 },
      "registrationFee": { "currency": "BRL", "amount": 8200.00 },
      "cet": { "monthlyPercentage": 0.02, "yearlyPercentage": 0.24 },
      "interestRate": { "monthlyPercentage": 0.02, "yearlyPercentage": 0.21 }
    }
  },  
  {
    "approvedAt": "2025-10-30",
    "application": {
      "installment": {
        "value": { "currency": "BRL", "amount": 8854.34 },
        "maturity": 240
      },
      "approvedCredit": { "currency": "BRL", "amount": 438896.99 },
      "netValues": { "currency": "BRL", "amount": 2102214.34 },
      "iof": { "currency": "BRL", "amount": 14628.13 },
      "registrationFee": { "currency": "BRL", "amount": 8200.00 },
      "cet": { "monthlyPercentage": 0.02, "yearlyPercentage": 0.24 },
      "interestRate": { "monthlyPercentage": 0.02, "yearlyPercentage": 0.21 }
    }
  }
]

O motor de decisão pode retornar diferentes cenários de propostas. Atualmente, as seguintes condições são possíveis:

Valor solicitado no menor prazo (taxa pós)
Valor solicitado no prazo solicitado (taxa pós)
Valor máximo no prazo máximo com dívidas condicionadas (taxa pós)
Valor máximo no prazo máximo (taxa pós)
Valor máximo no prazo máximo (taxa pré)

Todos essas condições irão ser retornadas dentro do response.

Informações sobre o retorno esperado

Confira abaixo as informações esperadas no retorno dessa consulta. Lembrando que será uma lista de todos os créditos aprovados.

Campos do response

Campo	Tipo	Descrição
`approvedAt`	date (YYYY-MM-DD)	Data da aprovação de crédito
`application.installment.value`	`currency`: string `amount`: double	Valor de cada parcela do empréstimo
`application.installment.maturity`	double	Quantidade total de parcelas
`application.approvedCredit`	`currency`: string `amount`: double	Valor total de crédito aprovado
`application.netValues`	`currency`: string `amount`: double	Valor líquido total do contrato
`application.iof`	`currency`: string `amount`: double	Imposto sobre operações financeiras aplicado na operação
`application.registrationFee`	`currency`: string `amount`: double	Taxa de Crédito (TC)
`application.cet`	`monthlyPercentage`: double `yearlyPercentage`: double	Custo Efetivo Total (CET)
`application.interestRate`	`monthlyPercentage`: double `yearlyPercentage`: double	Taxa de juros aplicada
`gracePeriod`	int	Tempo de carência
`amortizationStrategy`	string	Tabela de amortização, podendo ser SAC ou PRICE
`interestRateType`	string	Indexador da taxa, podendo ser pré-fixado ou pós-fixado (IPCA)

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui