Skip to main content
Este é um endpoint assíncrono. A resposta retornará imediatamente com um identificador para acompanhamento do status.
Após o trabalhador escolher uma das propostas simuladas, envie a proposta selecionada para aprovação juntamente com os dados bancários para desembolso.
Tenha certeza de enviar todos os dados pessoais e bancários corretamente.
O trabalhador pode ter apenas um contrato em andamento por vez. Caso o trabalhador tente enviar um novo contrato sem finalizar o anterior, a requisição será rejeitada com um erro de validação.Vide Cancelamento

​
Endpoint

​
POST
endpoint
/api/v1/e-consignado/contratos

​
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/contratos" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {seu_token_de_acesso}" \
  -d '{
    "idProposta": "019a25f5-7f74-783a-98e1-940fdab81a3a",
    "pessoa": {
      "naturalidade": "São Paulo",
      "documento": {
        "numero": "123456789",
        "orgaoExpedidor": "SSP",
        "uf": "SP",
        "dataDeEmissao": "2020-01-01",
        "tipoDocumento": "RG"
      },
      "endereco": {
        "rua": "Avenida Paulista",
        "numero": "1578",
        "complemento": "Apto 142",
        "bairro": "Bela Vista",
        "cidade": "São Paulo",
        "uf": "SP",
        "cep": "045204060"
      },
      "estadoCivil": "SOLTEIRO",
      "email": "[email protected]",
      "telefone": "+5511987654321"
    },
    "contaBancaria": {
      "compe": "341",
      "agencia": "0001",
      "conta": "12345-6",
      "tipo": "CORRENTE",
      "chavePix": "[email protected]"
    }
  }'

curl -X POST "https://integracao.apidev.wincred.digital/api/v1/e-consignado/contratos" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {seu_token_de_acesso}" \
  -d '{
    "idProposta": "019a25f5-7f74-783a-98e1-940fdab81a3a",
    "pessoa": {
      "naturalidade": "Rio de Janeiro",
      "documento": {
        "numero": "98765432109",
        "orgaoExpedidor": "DETRAN",
        "uf": "RJ",
        "dataDeEmissao": "2021-06-15",
        "tipoDocumento": "CNH"
      },
      "endereco": {
        "rua": "Rua das Flores",
        "numero": "456",
        "complemento": "Casa 2",
        "bairro": "Copacabana",
        "cidade": "Rio de Janeiro",
        "uf": "RJ",
        "cep": "22070010"
      },
      "estadoCivil": "CASADO",
      "email": "[email protected]",
      "telefone": "+5521998765432"
    },
    "contaBancaria": {
      "compe": "001",
      "agencia": "1234",
      "conta": "98765-4",
      "tipo": "CORRENTE",
      "chavePix": "+5521998765432"
    }
  }'

curl -X POST "https://integracao.apidev.wincred.digital/api/v1/e-consignado/contratos" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {seu_token_de_acesso}" \
  -d '{
    "idProposta": "019a25f5-7f74-783a-98e1-940fdab81a3a",
    "pessoa": {
      "naturalidade": "Belo Horizonte",
      "documento": {
        "numero": "MG1234567",
        "orgaoExpedidor": "SSP",
        "uf": "MG",
        "dataDeEmissao": "2019-03-20",
        "tipoDocumento": "RG"
      },
      "endereco": {
        "rua": "Rua dos Caetés",
        "numero": "789",
        "complemento": "",
        "bairro": "Savassi",
        "cidade": "Belo Horizonte",
        "uf": "MG",
        "cep": "30140071"
      },
      "estadoCivil": "DIVORCIADO",
      "email": "[email protected]",
      "telefone": "+5531912345678"
    },
    "contaBancaria": {
      "compe": "237",
      "agencia": "5678",
      "conta": "45678-9",
      "tipo": "POUPANCA",
      "chavePix": "12345678909"
    }
  }'

​
Parâmetros da Requisição

​
idProposta
string
required
Identificador único da proposta simulada que foi escolhida pelo trabalhador
​
pessoa
object
required
Dados pessoais do trabalhador
​
contaBancaria
object
required
Dados bancários para desembolso do empréstimo
É obrigatório o envio dos dados bancários completos ou de uma chave Pix válida.Não é necessário que se envie ambos os dados.
Caso uma chave Pix seja enviada em conjunto com os dados bancários, os dados bancários enviados serão substituídos pelos dados bancários vinculados à chave Pix.
Caso a chave pix não esteja vincula ao CPF do trabalhador a validação dos dados bancários é negada.

​
Resposta

​
Resposta de Sucesso (202 Accepted)

A requisição foi aceita e está sendo processada de forma assíncrona. 
{
  "idContrato": "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 aprovação da proposta.

Próximo: Consultar Status

Consultar o status e resultado da aprovação da proposta