Skip to main content
O segundo passo na contratação ativa é simular propostas de crédito consignado com base nos vínculo empregatício escolhido pelo trabalhador. A Wincred disponibiliza um endpoint assíncrono que recebe os dados do vínculo selecionado e que abstrai a complexidade, realizando:
  • Consulta de dados do trabalhador.
  • Simula propostas de crédito consignado conforme os parâmetros informados.

​
Endpoint

​
POST
endpoint
/api/v1/e-consignado/propostas/simulacoes

​
URL Base

HML: https://integracao.apidev.wincred.digital

​
Headers

HeaderTipoObrigatórioDescrição
Content-TypestringSimapplication/json
AuthorizationstringSimBearer {seu_token_de_acesso}

​
Requisição

​
Exemplo de Requisição

curl -X POST "https://integracao.apidev.wincred.digital/api/v1/e-consignado/propostas/simulacoes" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {seu_token_de_acesso}" \
  -d '{
    "idCotacao": "123e4567-e89b-12d3-a456-426614174000",
    "numeroParcelas": 24,
    "valor": 1500.00
    "empresa": { // Dados que retornam da dataprev
        "tipoInscricao": 1,
        "numeroInscricao": "12345678000195",
        "matricula": "123456",
    },
  }'

​
Parâmetros da Requisição

​
idCotacao
UUID
required
Identificador único da cotação retornado na etapa de consulta de vínculos. Exemplo: "123e4567-e89b-12d3-a456-426614174000"
​
numeroParcelas
int
required
Número de parcelas desejadas para a simulação de crédito consignado.Exemplo: 24
​
valor
float
required
Valor total do empréstimo para o qual se deseja simular a proposta de crédito consignado.Exemplo: 1500.00
​
empresa
object
required
Objeto contendo os dados da empresa e matrícula do trabalhador, conforme retornado pela DATAPREV na etapa de consulta de vínculos.

​
Resposta

​
Resposta de Sucesso (202 Accepted)

A requisição foi aceita e está sendo processada de forma assíncrona. 
{
  "idCotacao": "123e4567-e89b-12d3-a456-426614174000",
  "erros": []
}
Caso algum erro aconteça na requisição, uma lista de erros será retornada.documentação de erros

​
Resposta de Erro (404 Not Found)

{
    "erros": [
        {
            "codigo": "WIN_P00003",
            "msg": "Proposta não encontrada"
        }
    ]
}

​
Respostas de erro comuns no sistema

​
Resposta de Erro (4xx Bad Request)

{
    "erros": [
        {
            "codigo": "WIN_xxxx",
            "msg": "MENSGEM DE ERRO DESCRITIVA"
        }
    ]
}

​
Resposta de Erro (422 Unprocessable Entity)

{
  "erros": [
    {
      "codigo": "WIN_XXXX",
      "msg": "Proposta não encontrada"
    }
  ]
}

​
Resposta de Erro (401 Unauthorized)

{
  "code": 401,
  "message": ""
}
Esse payload é um retorno da API de autenticação e não da API do sistema.Esta resposta pode indicar que o token de autenticação fornecido é inválido ou expirou. Verifique se o token está correto e se ainda é válido.

​
Resposta de Erro (500 Unauthorized)

{
  "code": 500,
  "message": ""
}

​
Códigos de Status

CódigoDescrição
202Requisição aceita e em processamento
401Não autorizado - token inválido
422Erro de validação dos dados
429Muitas requisições, limite atingido
500Erro interno do servidor

​
Próximos Passos

1

Aguardar processamento

A consulta é processada de forma assíncrona. Aguarde alguns segundos antes de consultar o resultado.
2

Consultar resultado

Utilize o webhook para obter o resultado da simulação de propostas.
3

Comparar propostas

Com as propostas retornadas, você pode prosseguir para a próxima etapa de escolher a melhor opção de crédito consignado.

Próximo: Consultar Status

Consultar o status e resultado da simulação de propostas