Cria uma simulação de oferta


O recurso de ofertas é uma consulta das taxas de juros, custo efetivo total (CET) e valor da parcela mensal contendo valor mínimo e máximo em relação ao número de parcelas.

Importante ressaltar que:

  • Este endpoint não cria uma solicitação de empréstimo na Creditas, apenas calcula as taxas e valores. Para solicitação de empréstimo, utilize o endpoint de criação da proposta



Como fazer uma criação de simulação de Oferta


Request HTTP POST

Tipo da RequisiçãoURLExemplo
POST{{url_base}}/offershttps://stg-api.creditas.io/b2b/offers

Request Header

Para utilizar essa versão do simulador é necessário adaptar o header seguindo a informação abaixo.

HeaderValor
Acceptapplication/vnd.creditas.v1+json
Content-TypeAuthorization
AuthorizationBearer {{AUTHENTICATION_TOKEN}}

Request Params

CampoTipoObrigatórioDescrição
productTypestringSimAUTO_REFI
purposestringSimMotivos para solicitação de empréstimo.
Consulte os motivos de empréstimo.
borrowerobjectSimDados pessoais do solicitante do empréstimo.
Consulte o objeto do borrower
intendedCreditobjectSimInformações sobre a proposta de empréstimo.
Consulte o objeto do intendedCredit
metadataobjectNãoAs informações disponibilizadas nesse campo são necessárias para o rastreamento da informação e análise de dados.
collateralobjectSimDados da garantia do solicitante do empréstimo.
Consulte o objeto do collateral

Request Response

CampoTipoDescrição
idstringId da proposta
scoreFixedbooleanEstratégia de score utilizada fixa ou dinâmica
offerslistUma lista com os dados da oferta simulada. Consulte objeto do offer

Exemplo de Request

Request com todos os dados do collateral

curl --location --request POST '{{url_base}}/offers' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{
    "purpose": "DEBTS_PAYMENT",
    "metadata": {"version": "V2024"},
    "intendedCredit": {
        "currency": "BRL",
        "amount": 50000
    },
    "borrower": {
        "email": "[email protected]",
        "birthDate": "1996-06-03",
        "cellphone": "965984565",
        "cellphoneCode": "11",
        "monthlyIncome": 5500,
        "professionalStatus": "CLT",
        "postalCode": "09181000",
        "cpf": "65498745698",
        "timeOfEmployment": "LESS_THAN_SIX_MONTHS",
        "bacenAuthorization": {
            "authorizationTerms": "O cliente autorizou a consulta de informações a seu respeito mantidas no Sistema de Informações (SCR) organizado pelo Banco Central do Brasil.",
            "bacenAuthorizedAt": "2023-06-02",
            "userAgent": "userAgent",
            "userIp": "191.17.110.30"
        }
    },
    "collateral": {
        "value": 15000,
        "brand": "CHEVROLET",
        "model": "PRISMA",
        "modelYear": "2014",
        "modelVersion": "LT 1.0 8V SPE/4",
        "manufacturingYear": "2014",
        "borrowerVehicleOwner": true,
        "licensePlate": "DPX1O73",
        "ownerKinshipDegree": "SPOUSE"
    }
}'

Request sem todos os dados do collateral

curl --location --request POST '{{url_base}}/offers' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{
    "purpose": "DEBTS_PAYMENT",
    "intendedCredit": {
        "currency": "BRL",
        "amount": 50000
    },
    "borrower": {
        "email": "[email protected]",
        "birthDate": "1996-06-03",
        "cellphone": "965984565",
        "cellphoneCode": "11",
        "monthlyIncome": 5500,
        "professionalStatus": "CLT",
        "postalCode": "09181000",
        "cpf": "65498745698",
        "timeOfEmployment": "LESS_THAN_SIX_MONTHS",
        "bacenAuthorization": {
            "authorizationTerms": "O cliente autorizou a consulta de informações a seu respeito mantidas no Sistema de Informações (SCR) organizado pelo Banco Central do Brasil.",
            "bacenAuthorizedAt": "2023-06-02",
            "userAgent": "userAgent",
            "userIp": "191.17.110.30"
        }
    },
    "collateral": {
        "value": 15000,
        "debt": 5000,
        "borrowerVehicleOwner": true,
        "licensePlate": "DPX1O73",
        "pricingDetail": {
            "type": "MOLICAR",
            "code": "teste"
        }
    }
}'

Ambos exemplos são funcionais e não afetam os valores da simulação de oferta

Exemplo de Response

{
    "id": "OFR-DBC79D7F-E5D7-45B9-B9DD-A60C2561EA06",
    "scoreFixed": false,
    "approvedStatus": "ANALYSIS_CREATED",
    "offers": [
        {
            "loanTerm": 60,
            "monthlyInterestRate": 0.05,
            "totalEffectiveCost": 0.0359,
            "installmentAmount": 3000.17,
            "loanAmount": 27833.46,
            "iof": 27833.46
        }
    ]
}

Os possíveis status para o campo approvedStatus são:

  • ANALYSIS_ONGOING: processamento iniciado. Status será devolvido apenas caso consultado na rota GET /offers. Não será enviado via Webhook.
  • ANALYSIS_REFUSED: cliente recusado em alguma etapa de análise da Creditas, como pré-qualificação ou análise preliminar de crédito. Não será apresentada a oferta.
  • ANALYSIS_PRE_APPROVED: oferta com cliente pré-aprovado nas análises preliminares da Creditas, como pré-qualificação e análise preliminar de crédito. Obs: para a V1 da solução, em que daremos o preço sem rodar as aprovações, utilizaremos esse status temporariamente, visto que o desenvolvimento da V2 com as aprovações já está bem adiantado.
  • ANALYSIS_FIXED_SCORE: oferta apresentada com cliente não aprovado em todas as etapas preliminares e utilizando o Score Chumbado (700). Este status será utilizado para não perdermos clientes nos casos abaixo: BACEN negado, Timeout de processamento

Obs: internamente na Creditas teremos mais status com distinções para identificar em qual etapa o cliente foi aprovado/ negado. Assim, conseguiremos acompanhar o que está acontecendo com a base de clientes e localizar oportunidades. Optamos por condensar os status para os parceiros para tornar a integração mais simples.