Visão Geral

Quando uma proposta de crédito consignado é enviada para aprovação, a Wincred processa a solicitação e envia eventos em tempo real para o webhook configurado, informando sobre o progresso e resultado da contratação. Este webhook notifica sobre todas as etapas do ciclo de vida do contrato, desde a análise de KYC até a conclusão do desembolso.

Header do tipo do evento no Webhook:

x-event-type:
	"v1.e-consignado.contratacao-ativa.validacao-conta-bancaria"
	"v1.e-consignado.contratacao-ativa.kyc"
	"v1.e-consignado.contratacao-ativa.contratos"
	"v1.e-consignado.contratacao-ativa.averbacao-contrato"
	"v1.e-consignado.contratacao-ativa.dados-trabalhador-incluidos"
	"v1.e-consignado.contratacao-ativa.desembolso"
	"v1.e-consignado.contratacao-ativa.cancelamento"

Eventos e payloads nos webhooks

Validação de Dados Bancários

Evento: v1.e-consignado.contratacao-ativa.validacao-conta-bancaria

Contrato Enviado (Proposta)

Evento: v1.e-consignado.contratacao-ativa.contratos

Análise de KYC

Evento: v1.e-consignado.contratacao-ativa.kyc

Aprovação de Averbação

Evento: v1.e-consignado.contratacao-ativa.averbacao-contrato

Inclusão de Dados do Trabalhador

Evento: v1.e-consignado.contratacao-ativa.dados-trabalhador-incluidos

Desembolso

Evento: v1.e-consignado.contratacao-ativa.desembolso

Cancelamento de Contrato

Evento: v1.e-consignado.contratacao-ativa.cancelamento

Parâmetros

UUID

required

Identificador único do contrato no formato UUID

string

required

Tipo do evento. Valor fixo: v1.e-consignado.contratacao-ativa.contratos

string

required

Status atual do contrato. Os status seguem um fluxo sequencial dividido em quatro etapas principais:1. Validação de Dados Bancários:

VALIDANDO_DADOS_BANCARIOS - Primeira etapa do fluxo
DADOS_BANCARIOS_INVALIDOS - Requer correção via API (até 3 tentativas)
FALHA_VALIDACAO_DADOS_BANCARIOS - Dados inválidos após correção
LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO ⛔ Status final (após 3 tentativas)

2. Fluxo de geração da CCB:

CCB_GERADA - CCB gerada com sucesso
REJEITADO_PELA_INSTITUICAO_FINANCEIRA ⛔ Status final

3. Fluxo de KYC:

PROCESSANDO_KYC
PROCESSO_KYC_APROVADO - Continua o fluxo
PROCESSO_REJEITADO_PELO_KYC ⛔ Status final

4. Fluxo de Averbação:

AGUARDANDO_APROVACAO_AVERBACAO
AVERBACAO_REJEITADA ⛔ Status final
AVERBACAO_APROVADA_ANEXANDO_DADOS_TRABALHADOR
FALHA_ADICAO_DADOS_TRABALHADOR

5. Fluxo de Desembolso:

AGUARDANDO_DESEMBOLSO
DESEMBOLSO_REALIZADO ✅ Status final de sucesso

Consulte os acordeões abaixo para detalhes de cada status.

object

Objeto opcional contendo dados adicionais relacionados ao eventos do contrato.

Show Campos

string

required

Numero do CCB.

object

required

Objeto opcional que contem informações sobre o processo de KYC

Show Campos

string

required

Link do processo de KYC para consulta externa

string

required

Data e hora da criação do evento no formato ISO 8601 (UTC)

Status do Contrato

Abra os acordeões abaixo para entender cada status possível do contrato:

Validação de Dados Bancários

VALIDANDO_DADOS_BANCARIOS

O contrato está em processo de validação dos dados bancários fornecidos pelo cliente. Esta é a primeira etapa do fluxo, executada antes do processo de KYC. São verificados se os dados estão corretos e aptos para o desembolso.Próximos status possíveis:

CCB_GERADA (dados válidos)
DADOS_BANCARIOS_INVALIDOS (dados inválidos)

DADOS_BANCARIOS_INVALIDOS

Os dados bancários fornecidos pelo cliente são inválidos ou incorretos. O fluxo não pode ser continuado até que os dados sejam corrigidos.Ação necessária: Atualize os dados bancários do cliente através da API de correção. O sistema permite até 3 tentativas de correção.Próximos status possíveis:

FALHA_VALIDACAO_DADOS_BANCARIOS (se os dados corrigidos ainda estiverem inválidos)
PROCESSANDO_KYC (se os dados forem corrigidos com sucesso)

FALHA_VALIDACAO_DADOS_BANCARIOS

Os dados bancários corrigidos através da API ainda estão inválidos. Este status indica uma nova tentativa de validação que falhou.Sistema de tentativas: O sistema permite até 3 tentativas de correção dos dados bancários.Próximos status possíveis:

LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO (após a 3ª tentativa falhada)
PROCESSANDO_KYC (se os dados forem corrigidos com sucesso)

LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO

O limite máximo de 3 tentativas de correção dos dados bancários foi excedido. O contrato não prosseguirá e não será possível fazer novas tentativas de correção.Status final: ⛔ Este é um status terminal. O contrato foi encerrado devido ao número máximo de tentativas de validação bancária ter sido excedido. Para prosseguir, será necessário criar uma nova proposta.

Fluxo de geração da CCB

CCB_GERADA

A Cédula de Crédito Bancário (CCB) foi gerada com sucesso e o contrato está pronto para prosseguir para a etapa de averbação.Próximos status possíveis:

PROCESSANDO_KYC
REJEITADO_PELA_INSTITUICAO_FINANCEIRA

REJEITADO_PELA_INSTITUICAO_FINANCEIRA

A proposta foi rejeitada pela instituição financeira durante a geração da CCB. O contrato não prosseguirá.Status final: ⛔ Este é um status terminal. Consulte os detalhes do contrato para entender o motivo da rejeição.

Fluxo de KYC

PROCESSANDO_KYC

O contrato está em análise de Know Your Customer (KYC). Nesta etapa, são verificadas informações cadastrais, documentação e elegibilidade do cliente.Próximos status possíveis:

PROCESSO_KYC_APROVADO (aprovado no KYC, continuando o fluxo)
PROCESSO_REJEITADO_PELO_KYC (reprovado no KYC)
FALHA_PROCESSO_KYC (erro técnico durante o processo)

PROCESSO_KYC_APROVADO

A análise de Know Your Customer (KYC) foi concluída com sucesso. O cliente passou nas verificações de segurança e conformidade.Próximos status possíveis:

AGUARDANDO_APROVACAO_AVERBACAO

PROCESSO_REJEITADO_PELO_KYC

A proposta foi rejeitada durante a análise de KYC. O contrato não prosseguirá.Status final: ⛔ Este é um status terminal. Consulte os detalhes do contrato para entender o motivo da rejeição.

FALHA_PROCESSO_KYC

Ocorreu uma falha técnica durante o processo de KYC. O contrato não prosseguirá.Status final: ⛔ Entre em contato com o suporte técnico para entender a causa da falha e resolver o problema.

Fluxo de Averbação

AGUARDANDO_APROVACAO_AVERBACAO

A averbação foi solicitada e está aguardando aprovação do órgão/instituição pagadora. Nesta etapa, o contrato está sendo analisado pela entidade responsável pelo pagamento da folha.Próximos status possíveis:

AVERBACAO_APROVADA_ANEXANDO_DADOS_TRABALHADOR
AVERBACAO_REJEITADA
FALHA_AVERBACAO
FALHA_ADICAO_DADOS_TRABALHADOR

AVERBACAO_APROVADA_ANEXANDO_DADOS_TRABALHADOR

A averbação foi aprovada pelo órgão/instituição pagadora e os dados do trabalhador estão sendo anexados ao sistema. O contrato está pronto para prosseguir ao desembolso.Próximos status possíveis:

AGUARDANDO_DESEMBOLSO

AVERBACAO_REJEITADA

A averbação foi rejeitada pelo órgão/instituição pagadora. O contrato não prosseguirá.Motivos comuns:

Margem do cliente não está mais disponível no momento da averbação
Inconsistências nos dados cadastrais
Restrições do órgão pagador

Status final: ⛔ Este é um status terminal. Consulte os detalhes do contrato para entender o motivo específico da rejeição.

FALHA_AVERBACAO

Ocorreu uma falha técnica durante o processo de averbação. O contrato não prosseguirá.Status final: ⛔ Entre em contato com o suporte técnico para entender a causa da falha e resolver o problema.

FALHA_ADICAO_DADOS_TRABALHADOR

Ocorreu uma falha ao anexar os dados do trabalhador após a aprovação da averbação. Esta etapa é crucial para o prosseguimento do contrato.Ação necessária: Entre em contato com o suporte técnico para entender a causa da falha e resolver o problema.Próximos status possíveis:

AGUARDANDO_DESEMBOLSO (se os dados forem anexados com sucesso)

Fluxo de Desembolso

AGUARDANDO_DESEMBOLSO

O contrato está aguardando o processamento do desembolso para a conta do cliente. Todas as aprovações foram concluídas e o valor está pronto para ser transferido.Próximos status possíveis:

DESEMBOLSO_REALIZADO

DESEMBOLSO_REALIZADO

O desembolso foi realizado com sucesso na conta do cliente. O valor foi transferido e o contrato está finalizado.Status final: ✅ Este é o status de sucesso da jornada completa do contrato. O processo foi concluído com êxito.

Fluxo de Estados

Exemplos de Payloads

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.validacao-conta-bancaria",
  "status": "VALIDANDO_DADOS_BANCARIOS",
  "dataCriacao": "2024-06-10T14:00:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.validacao-conta-bancaria",
  "status": "DADOS_BANCARIOS_INVALIDOS",
  "dataCriacao": "2024-06-10T14:10:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.kyc",
  "status": "FALHA_VALIDACAO_DADOS_BANCARIOS",
  "dataCriacao": "2024-06-10T14:25:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.contratos",
  "status": "LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO",
  "dataCriacao": "2024-06-10T14:50:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.kyc",
  "status": "PROCESSANDO_KYC",
  "dataCriacao": "2024-06-10T14:30:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.kyc",
  "status": "AGUARDANDO_APROVACAO_AVERBACAO",
  "dataCriacao": "2024-06-10T15:15:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.averbacao-contrato",
  "status": "AVERBACAO_APROVADA_ANEXANDO_DADOS_TRABALHADOR",
  "dataCriacao": "2024-06-10T16:45:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.dados-trabalhador-incluidos",
  "status": "AGUARDANDO_DESEMBOLSO",
  "dataCriacao": "2024-06-10T17:30:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.desembolso",
  "status": "DESEMBOLSO_REALIZADO",
  "dataCriacao": "2024-06-10T18:20:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.kyc",
  "status": "PROCESSO_REJEITADO_PELO_KYC",
  "dataCriacao": "2024-06-10T15:00:00Z"
}

{
  "idContrato": "123e4567-e89b-12d3-a456-426614174000",
  "evento": "v1.e-consignado.contratacao-ativa.contratos",
  "status": "FALHA_AVERBACAO",
  "dataCriacao": "2024-06-10T16:30:00Z"
}

Sistema de Correção de Dados Bancários

Sistema de Tentativas:

O sistema permite até 3 tentativas de correção dos dados bancários
Para os status DADOS_BANCARIOS_INVALIDOS ou FALHA_VALIDACAO_DADOS_BANCARIOS, utilize a API de atualização de dados bancários para corrigir as informações
O fluxo será retomado automaticamente após cada correção
Após a 3ª tentativa falhada, o contrato será finalizado com status LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO
Neste caso, será necessário criar uma nova proposta para prosseguir

A API de correção de dados bancários será disponibilizada em uma próxima entrega. Até lá, os webhooks com os novos status já estarão disponíveis no ambiente de homologação.

Status Finais

Os seguintes status indicam que o contrato chegou ao fim de sua jornada:

Status	Resultado	Descrição
`DESEMBOLSO_REALIZADO`	✅ Sucesso	Desembolso realizado com sucesso
`PROCESSO_REJEITADO_PELO_KYC`	❌ Rejeição	Reprovado na análise de KYC
`FALHA_PROCESSO_KYC`	❌ Falha	Falha técnica durante o processo de KYC
`AVERBACAO_REJEITADA`	❌ Rejeição	Averbação rejeitada pelo órgão pagador
`LIMITE_MAXIMO_TENTATIVAS_VALIDACAO_DADOS_BANCARIOS_EXCEDIDO`	❌ Rejeição	Limite de 3 tentativas de validação bancária excedido
`REJEITADO_PELA_INSTITUICAO_FINANCEIRA`	❌ Rejeição	Proposta rejeitada pela instituição financeira durante a geração da CCB
`FALHA_AVERBACAO`	❌ Falha	Falha técnica durante o processo de averbação
`FALHA_ADICAO_DADOS_TRABALHADOR`	❌ Falha	Falha ao anexar os dados do trabalhador após a aprovação da averbação

Guia Inicial

Comece por Aqui

Casos de Uso

03 - Eventos de Resultado de Proposta

Visão Geral

Header do tipo do evento no Webhook:

Eventos e payloads nos webhooks

Parâmetros

Status do Contrato

Validação de Dados Bancários

Fluxo de geração da CCB

Fluxo de KYC

Fluxo de Averbação

Fluxo de Desembolso

Fluxo de Estados

Exemplos de Payloads

Sistema de Correção de Dados Bancários

Status Finais

​Visão Geral

​Header do tipo do evento no Webhook:

​Eventos e payloads nos webhooks

​Parâmetros

​Status do Contrato

​Validação de Dados Bancários

​Fluxo de geração da CCB

​Fluxo de KYC

​Fluxo de Averbação

​Fluxo de Desembolso

​Fluxo de Estados

​Exemplos de Payloads

​Sistema de Correção de Dados Bancários

​Status Finais

Visão Geral

Header do tipo do evento no Webhook:

Eventos e payloads nos webhooks

Parâmetros

Status do Contrato

Validação de Dados Bancários

Fluxo de geração da CCB

Fluxo de KYC

Fluxo de Averbação

Fluxo de Desembolso

Fluxo de Estados

Exemplos de Payloads

Sistema de Correção de Dados Bancários

Status Finais