Consultar Condições de Crédito

1. Avisos Importantes

Para efetuar essa consulta, é necessário ter uma proposta criada e ter recebido o identificador (proposal_id) dessa solicitação.
Para este endpoint, há um limite de 100 requisições diárias para cada proposta.

2. Referência Técnica

2.1. Request HTTP

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

2.2. Request Headers

Header	Valor
`Accept`	application/vnd.creditas.v1+json
`Content-Type`	application/json;charset=UTF-8
`Authorization`	Bearer `{{AUTHENTICATION_TOKEN}}`

2.3. 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

2.4. Exemplo de Request e Response

curl --location --request GET '{{url_base}}/proposals/{{proposalId}}/conditions/credit-approved' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'

{
    "approvedAt": "2022-08-19",
    "application": {
        "installment": {
            "value": {
                "currency": "BRL",
                "amount": 647.68
            },
            "maturity": 12
        },
        "approvedCredit": {
            "currency": "BRL",
            "amount": 5000.0
        },
        "netValues": {
            "currency": "BRL",
            "amount": 7772.16
        },
        "iof": {
            "currency": "BRL",
            "amount": 139.58
        },
        "registrationFee": {
            "currency": "BRL",
            "amount": 600.0
        },
        "cet": {
            "monthlyPercentage": 6.28,
            "yearlyPercentage": 0.00
        },
        "interestRate": {
            "monthlyPercentage": 3.65,
            "yearlyPercentage": 53.76
        }
    }
}

3. Informações sobre o retorno esperado

3.1. 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 de parcelas
`application.approvedCredit`	`currency`: string `amount`: double	Valor total do crédito aprovado
`application.netValues`	`currency`: string `amount`: double	Valor total a ser pago (maturity * value)
`application.iof`	`currency`: string `amount`: double	Imposto sobre operações financeiras
`application.registrationFee`	`currency`: string `amount`: double	Taxa de abertura de crédito
`application.cet`	`monthlyPercentage`: double `yearlyPercentage`: double	Custo efetivo total
`application.interestRate`	`monthlyPercentage`: double `yearlyPercentage`: double	Taxa de juros

4. Possíveis Erros

Consulte os possíveis retornos de erros clicando aqui