Atualizar Dados Bancários

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

endpoint

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

URL Base

https://integracao.apidev.wincred.digital

Headers

Header	Tipo	Obrigatório	Descrição
`Content-Type`	string	Sim	`application/json`
`Authorization`	string	Sim	`Bearer {seu_token_de_acesso}`

Parâmetros

Path Parameters

UUID

required

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

Request Body

object

required

Objeto contendo os dados bancários atualizados

Show Propriedades de contaBancaria

string

required

Código COMPE do banco (3 dígitos)Exemplo: "070" (Banco BRB)

string

required

Número da agência bancária (sem dígito verificador)Exemplo: "1155"

string

required

Número da conta com dígito verificadorFormato: "XXXXXX-X"Exemplo: "44558-8"

string

required

Tipo da conta bancáriaValores aceitos:

CORRENTE - Conta corrente
POUPANCA - Conta poupança

string

Chave PixExemplo: "email@exemplo.com"Obs: Ao enviar chaves pix como numero de telefone/CPF/CNPJ deve-se remover todos carcteres que não sejam dígitos.

Regras de Negócio

Status do Contrato

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.

Validade da Proposta

A proposta deve estar dentro do prazo de validade. Propostas expiradas não podem ter seus dados bancários atualizados.

Limite de Tentativas

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.

Bancos Aceitos

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ódigo	Descrição
`202`	Requisição aceita e em processamento
`401`	Não autorizado - token inválido
`422`	Erro de validação dos dados
`429`	Muitas requisições, limite atingido
`500`	Erro 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"
    }
}'

const response = await fetch(
  'https://api.wincred.com.br/api/v1/e-consignado/contratos/019a7d83-6b10-7ec8-ad35-fbcb2a61bb17/dados-bancarios',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer seu-token-aqui'
    },
    body: JSON.stringify({
      contaBancaria: {
        compe: '070',
        agencia: '1155',
        conta: '44558-8',
        tipo: 'CORRENTE'
      }
    })
  }
);

const data = await response.json();
console.log(data);

import requests

url = "https://api.wincred.com.br/api/v1/e-consignado/contratos/019a7d83-6b10-7ec8-ad35-fbcb2a61bb17/dados-bancarios"

payload = {
    "contaBancaria": {
        "compe": "070",
        "agencia": "1155",
        "conta": "44558-8",
        "tipo": "CORRENTE"
    }
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer seu-token-aqui"
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

Cenários de Uso

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

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

Cenário 2: Segunda ou Terceira Tentativa

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

Cenário 3: Limite de Tentativas Excedido

Após 3 tentativas de correção sem sucesso
Wincred cancela automaticamente o contrato
Webhook notifica: LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO
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.

Guia Inicial

Comece por Aqui

Casos de Uso

Atualizar Dados Bancários

Endpoint

URL Base

Headers

Parâmetros

Path Parameters

Request Body

Regras de Negócio

Respostas

200 - Success

Respostas de erro comuns no sistema

Resposta de Erro (4xx Bad Request)

Resposta de Erro (422 Unprocessable Entity)

Resposta de Erro (401 Unauthorized)

Resposta de Erro (500 Unauthorized)

Códigos de Status

Exemplos

Cenários de Uso

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

Cenário 2: Segunda ou Terceira Tentativa

Cenário 3: Limite de Tentativas Excedido

Relacionado

Eventos de Resultado de Proposta

​Endpoint

​URL Base

​Headers

​Parâmetros

​Path Parameters

​Request Body

​Regras de Negócio

​Respostas

​200 - Success

​Respostas de erro comuns no sistema

​Resposta de Erro (4xx Bad Request)

​Resposta de Erro (422 Unprocessable Entity)

​Resposta de Erro (401 Unauthorized)

​Resposta de Erro (500 Unauthorized)

​Códigos de Status

​Exemplos

​Cenários de Uso

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

​Cenário 2: Segunda ou Terceira Tentativa

​Cenário 3: Limite de Tentativas Excedido

​Relacionado

Eventos de Resultado de Proposta

Endpoint

URL Base

Headers

Parâmetros

Path Parameters

Request Body

Regras de Negócio

Respostas

200 - Success

Respostas de erro comuns no sistema

Resposta de Erro (4xx Bad Request)

Resposta de Erro (422 Unprocessable Entity)

Resposta de Erro (401 Unauthorized)

Resposta de Erro (500 Unauthorized)

Códigos de Status

Exemplos

Cenários de Uso

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

Cenário 2: Segunda ou Terceira Tentativa

Cenário 3: Limite de Tentativas Excedido

Relacionado