Skip to main content
Esta API permite atualizar os dados bancários de um contrato quando a validação inicial falhar. É utilizada como parte do fluxo de correção de dados bancários inválidos durante o processo de contratação.
Esta API só pode ser utilizada quando o contrato estiver nos status DADOS_BANCARIOS_INVALIDOS ou FALHA_VALIDACAO_DADOS_BANCARIOS e antes da data de expiração da proposta. O sistema permite no máximo 3 tentativas de atualização.

​
Endpoint

​
PUT
endpoint
/api/v1/e-consignado/contratos/{idContrato}/dados-bancarios

​
URL Base

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

​
Headers

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

​
Parâmetros

​
Path Parameters

​
idContrato
UUID
required
Identificador único do contrato que terá os dados bancários atualizadosExemplo: 019a7d83-6b10-7ec8-ad35-fbcb2a61bb17

​
Request Body

​
contaBancaria
object
required
Objeto contendo os dados bancários atualizados

​
Regras de Negócio

A atualização dos dados bancários só é permitida quando o contrato está no status DADOS_BANCARIOS_INVALIDOS ou FALHA_VALIDACAO_DADOS_BANCARIOS e antes da data de expiração da proposta. Tentativas de atualização em outros status resultarão em erro.
A proposta deve estar dentro do prazo de validade. Propostas expiradas não podem ter seus dados bancários atualizados.
Um contrato pode ter seus dados bancários atualizados no máximo 3 vezes. Após a terceira tentativa de correção sem sucesso, o contrato é automaticamente cancelado com o status LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO.
Apenas bancos homologados pela Wincred são aceitos. O envio de um código COMPE não suportado resultará em erro 422.

​
Respostas

​
200 - Success

A requisição foi bem-sucedida e os dados bancários foram atualizados.

​
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

​
Exemplos

curl --location --request PUT 'https://api.wincred.com.br/api/v1/e-consignado/contratos/019a7d83-6b10-7ec8-ad35-fbcb2a61bb17/dados-bancarios' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer seu-token-aqui' \
--data '{
    "contaBancaria": {
        "compe": "070",
        "agencia": "1155",
        "conta": "44558-8",
        "tipo": "CORRENTE"
    }
}'

​
Cenários de Uso

​
Cenário 1: Primeira Tentativa de Correção

  1. Webhook notifica: DADOS_BANCARIOS_INVALIDOS
  2. Sistema coleta novos dados bancários do cliente
  3. Sistema chama API de atualização
  4. API retorna 200 (sucesso)
  5. Processo de validação reinicia
  6. Se válido: Webhook notifica PROCESSANDO_KYC

​
Cenário 2: Segunda ou Terceira Tentativa

  1. Webhook notifica: FALHA_VALIDACAO_DADOS_BANCARIOS
  2. Sistema solicita revisão dos dados ao cliente
  3. Sistema chama API de atualização novamente
  4. API retorna 200 (sucesso)
  5. Processo de validação reinicia
  6. Se válido: Webhook notifica PROCESSANDO_KYC

​
Cenário 3: Limite de Tentativas Excedido

  1. Após 3 tentativas de correção sem sucesso
  2. Wincred cancela automaticamente o contrato
  3. Webhook notifica: LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO
  4. Necessário criar uma nova proposta
Dica: Implemente uma validação de formato dos dados bancários no frontend antes de enviar para a API, melhorando a experiência do usuário e reduzindo tentativas de correção.

​
Relacionado

Eventos de Resultado de Proposta

Entenda os webhooks relacionados à resultado da proposta.