Criação da proposta com garantia
Endpoint para enviar uma solicitação de empréstimo com automóvel em garantia
As solicitações de empréstimo com automóvel em garantia, incluem dados básicos da pessoa solicitante, do veículo dado como garantia, e dados da proposta em si, como prazo e valor solicitados.
Essa seção descreve a criação e manipulação das solicitações de refinanciamento de automóvel.
Recomendações importantes Autorização Bacen e WhatsappOption
Enviar dados bancários
Como enviar uma solicitação de empréstimo
As informações enviadas devem seguir o request headers e request body a seguir:
Request HTTP POST
Tipo da Requisição | URL | Exemplo |
---|---|---|
POST | {{url_base}}/proposals | https://stg-api.creditas.io/b2b/proposals |
Request Headers
Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.
Request Body
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
productType | string | Sim | AUTO_REFI |
offerId | string | Não | Id da oferta usada como referência para gerar a proposta. Consulte como criar uma oferta. |
purpose | string | Sim | Motivos para solicitação de empréstimo. Consulte os motivos de empréstimo. |
borrower | object | Sim | Dados pessoais do solicitante do empréstimo. Consulte o objeto do borrower |
intendedCredit | object | Sim | Informações sobre a proposta de empréstimo. Consulte o objeto do intendedCredit |
conditions | object | Sim | Condições de parcelamento do empréstimo. Consulte o objeto do conditions |
collateral | object | Sim | Dados da garantia do solicitante do empréstimo. Consulte o objeto do collateral |
metadata | object | Não | As informações disponibilizadas nesse campo são necessárias para o rastreamento da informação e análise de dados. |
Request Response
Campo | Tipo | Descrição |
---|---|---|
id | string | Id da proposta |
legacyId | string | Id (Esse campo ira ser depreciado e sera removido) |
productType | string | Produto referente a proposta enviada |
Exemplo de Request e Response
curl --location --request POST '{{url_base}}/proposals' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{"productType":"AUTO_REFI","offerId":"OFR-D8FCB7C4-E127-493C-9154-63932289761D", "purpose":"VEHICLE_FINANCING", "metadata": "{"version": "V2024"}", "borrower":{"fullName":"complete name", "email":"[email protected]", "birthDate":"1991-01-29", "cellphone":"999999999", "cellphoneCode":"31", "monthlyIncome":12345.6, "professionalStatus":"SELF_EMPLOYED", "jobTitle":"Açougueiro(a)", "authorizationTerms":"Eu autorizo...", "postalCode":"91770552", "cpf":12345678900, "optIns":{"whatsApp":true, "sms":false, "email":false}, "bankDetails":{"bankNumber":"1", "account":"01234567", "branch":"0423", "accountType":"SAVING_ACCOUNT", "accountOwnership":"INDIVIDUAL"}}, "intendedCredit":{"currency":"BRL", "amount":5001.0}, "conditions":{"installment":{"term":24}}, "collateral":{"value":57198.0, "brand":"HYUNDAI", "model":"VISION", "modelYear":2021, "manufacturingYear":2007, "modelVersion":"HB20 VISION 1.0 12V MT5", "borrowerVehicleOwner":true, "debt":0, "licensePlate":"abc1234", "numberOfDoors":4, "fuelType":"ALCO/GASOL.", "accessoryPackage":"Basico", "pricingDetail":{"type":"MOLICAR", "code":"XXXXX-X"}}}'
{
"id": "B2B-DBC79D7F-E5D7-45B9-B9DD-A60C2561EA06",
"legacyId": "68e7e502-2e71-4c4c-a868-9c8c438fe19d",
"productType": "AUTO_REFI"
}
Ambiente de Staging
Com o intuito de auxiliar nos testes de integração foi criada uma regra em ambiente de staging onde:
- Propostas com CPF começando com 2 terão a oferta automaticamente negada.
Exemplo:2XXXXXXXXXX
- Propostas com CPF começando com 7 terão a oferta automaticamente aprovada.
Exemplo:7XXXXXXXXXX
- Propostas sem o campo
collateral.pricingDetail
não serão processadasCertifique-se de seguir essas regras no ambiente de testes (staging) para validar corretamente a integração.
Possíveis Erros
Consulte os possíveis retornos de erros, clique aqui
Updated 3 months ago