Eventos de Consignado

O Lerian Consignado emite 21 fatos de negócio como CloudEvents 1.0 por meio do lib-streaming v3. Cada fato abaixo tem um ponto de emissão em produção em develop e entra no outbox transacional antes da publicação.

Os contratos de payload abaixo descrevem o objeto data do CloudEvent. Uma propriedade marcada com ? pode ser omitida. null só é permitido quando estiver escrito explicitamente.

Contrato do fluxo de aplicação

Elemento no wire	Valor
Tópico de fatos	`lerian.streaming.consignado-gw`
`ce-source`	`consignado-gw`
`ce-type`	`studio.lerian.consignado-gw.<resource>.<event>`
Chave de dispatch	`<resource>.<event>` a partir de `ce-resourcetype` e `ce-eventtype`
`ce-schemaversion`	`1.0.0`
Chave de partição	Identificador do tenant
Entrega	Pelo menos uma vez por meio do outbox transacional

O tópico identifica a aplicação produtora, não um evento. Roteie por ce-source, ce-resourcetype e ce-eventtype; use ce-type como a composição qualificada pela fonte. Nunca infira o evento pelo nome do tópico.

Catálogo de eventos emitidos

Chave de definição	`ce-type`	Recurso / evento	`ce-subject`	Gatilho de emissão
`consignado.solicitacao.received`	`studio.lerian.consignado-gw.consignado_solicitacao.received`	`consignado_solicitacao` / `received`	`id_solicitacao`	Uma solicitação de empréstimo aberta é descoberta na Dataprev.
`consignado.portability_proposal.received`	`studio.lerian.consignado-gw.consignado_portability_proposal.received`	`consignado_portability_proposal` / `received`	`id_solicitacao`	Uma oferta M011 de portabilidade válida é descoberta e gravada com seu envelope de outbox.
`consignado.margin.fetched`	`studio.lerian.consignado-gw.consignado_margin.fetched`	`consignado_margin` / `fetched`	`request_ref`	A margem do trabalhador é consultada na Dataprev.
`consignado.proposal.accepted`	`studio.lerian.consignado-gw.consignado_proposal.accepted`	`consignado_proposal` / `accepted`	`proposal_ref`	A proposta aceita no trilho é confrontada com o lance durável do cliente.
`consignado.averbacao.confirmed`	`studio.lerian.consignado-gw.consignado_averbacao.confirmed`	`consignado_averbacao` / `confirmed`	`contract_id`	A Dataprev confirma a averbação.
`consignado.averbacao.rejected`	`studio.lerian.consignado-gw.consignado_averbacao.rejected`	`consignado_averbacao` / `rejected`	`contract_id`	A Dataprev rejeita a averbação.
`consignado.contract.registered`	`studio.lerian.consignado-gw.consignado_contract.registered`	`consignado_contract` / `registered`	`numero_contrato`	O limite imutável de booking do contrato é alcançado.
`consignado.disbursement.confirmed`	`studio.lerian.consignado-gw.consignado_disbursement.confirmed`	`consignado_disbursement` / `confirmed`	`numero_contrato`	O cliente confirma que o trabalhador recebeu os recursos.
`consignado.exclusao.confirmed`	`studio.lerian.consignado-gw.consignado_exclusao.confirmed`	`consignado_exclusao` / `confirmed`	`numero_contrato`	A exclusão do contrato alcança um estado terminal bem-sucedido.
`consignado.exclusao.rejected`	`studio.lerian.consignado-gw.consignado_exclusao.rejected`	`consignado_exclusao` / `rejected`	`numero_contrato`	A exclusão do contrato alcança um estado terminal rejeitado.
`consignado.redirecionamento.confirmed`	`studio.lerian.consignado-gw.consignado_redirecionamento.confirmed`	`consignado_redirecionamento` / `confirmed`	`request_ref`	O redirecionamento é confirmado.
`consignado.redirecionamento.rejected`	`studio.lerian.consignado-gw.consignado_redirecionamento.rejected`	`consignado_redirecionamento` / `rejected`	`request_ref`	O redirecionamento é rejeitado.
`consignado.reconciliation.received`	`studio.lerian.consignado-gw.consignado_reconciliation.received`	`consignado_reconciliation` / `received`	`object_ref`	Um registro de escrituração, repasse ou CSV de portal é normalizado.
`consignado.employment_status.reported`	`studio.lerian.consignado-gw.consignado_employment_status.reported`	`consignado_employment_status` / `reported`	`record_id`	Um registro de suspensão ou desligamento empregatício é consultado.
`consignado.afastamento.reported`	`studio.lerian.consignado-gw.consignado_afastamento.reported`	`consignado_afastamento` / `reported`	`SHA-256(payload)`	Um alerta de afastamento ou desligamento do trabalhador é reportado.
`consignado.throughput.changed`	`studio.lerian.consignado-gw.consignado_throughput.changed`	`consignado_throughput` / `changed`	`tenant_id`	O throughput efetivo da Dataprev para um tenant é alterado.
`consignado.cessao.registered`	`studio.lerian.consignado-gw.consignado_cessao.registered`	`consignado_cessao` / `registered`	`idempotency_key`	Uma cessão de crédito é registrada no domínio do gateway.
`consignado.repasse.overdue`	`studio.lerian.consignado-gw.consignado_repasse.overdue`	`consignado_repasse` / `overdue`	`object_ref`	Um repasse esperado ultrapassa o prazo ou não possui prazo calculável.
`consignado.repasse.resolved`	`studio.lerian.consignado-gw.consignado_repasse.resolved`	`consignado_repasse` / `resolved`	`object_ref`	Um movimento resolve um repasse em atraso.
`consignado.repasse.unobserved`	`studio.lerian.consignado-gw.consignado_repasse.unobserved`	`consignado_repasse` / `unobserved`	`object_ref`	O gateway não consegue estabelecer uma observação atual do trilho para as expectativas.
`consignado.calendar.published`	`studio.lerian.consignado-gw.consignado_calendar.published`	`consignado_calendar` / `published`	`competencia_consulta`	Uma janela do calendário operacional de descontos é publicada.

Notação dos payloads

O wire usa JSON com propriedades em snake_case. Estes aliases descrevem os formatos usados pelos schemas:

type Decimal = string
type RFC3339 = string
type DateOnly = string
type YearMonth = string
type UUID = string
type RailCodePair = {
  codigo: number
  descricao: string
}

Contratos de payload

consignado.solicitacao.received

Uma solicitação de empréstimo aberta é descoberta na Dataprev.Subject: id_solicitacao

type ConsignadoSolicitacaoReceivedV1 = {
id_solicitacao: string
codigo_solicitante: string
cpf: string
matricula: string
nome_trabalhador: string
data_nascimento: DateOnly | ""
inscricao_empregador: RailCodePair | null
numero_inscricao_empregador: string
data_admissao: DateOnly | ""
valor_liberado: Decimal
nro_parcelas: number
margem_disponivel: Decimal
elegivel_emprestimo?: boolean
data_hora_validade_solicitacao: RFC3339
pessoa_exposta_politicamente?: RailCodePair
garantias: {
  tem_garantias: boolean
  valor_saldo_disponivel_garantia_fgts?: Decimal
  valor_multa_rescisoria_garantia_fgts?: Decimal
  perc_verba_rescisoria_garantia?: Decimal
}
discovered_at: RFC3339
}

consignado.portability_proposal.received

Uma oferta M011 de portabilidade válida é descoberta e gravada com seu envelope de outbox.Subject: id_solicitacao

type ConsignadoPortabilityProposalReceivedV1 = {
id_solicitacao: string
cpf: string
matricula: string
nome_trabalhador: string
numero_inscricao_empregador: string
margem_disponivel: Decimal
elegivel_emprestimo?: boolean
data_hora_validade_solicitacao: RFC3339
}

consignado.margin.fetched

A margem do trabalhador é consultada na Dataprev.Subject: request_ref

type ConsignadoMarginFetchedV1 = {
request_ref: string
cpf: string
matricula: string
available_margin: Decimal
remuneracao_disponivel: Decimal
valor_total_vencimentos?: Decimal
elegivel?: boolean
motivo_inelegibilidade?: RailCodePair
tipo_bloqueio?: RailCodePair
qtd_emprestimos_ativos_suspensos?: number
data_desligamento?: DateOnly
codigo_motivo_desligamento?: string
percentual_verba_rescisoria_disponivel?: Decimal
as_of: RFC3339
}

consignado.proposal.accepted

A proposta aceita no trilho é confrontada com o lance durável do cliente.Subject: proposal_ref

type ConsignadoProposalAcceptedV1 = {
proposal_ref: string
id_solicitacao: string
numero_proposta: string
numero_contrato: string
cpf: string
matricula: string
numero_inscricao_empregador: string
principal_amount: Decimal
liberated_amount: Decimal
installment_amount: Decimal
installment_count: number
monthly_rate: Decimal
annual_rate: Decimal
cet_monthly: Decimal
cet_annual: Decimal
iof_amount: Decimal
situacao_emprestimo?: number
situacao_descricao?: string
garantia?: {
  tem_garantias: boolean
  valor_saldo_disponivel_garantia_fgts?: Decimal
  valor_multa_rescisoria_garantia_fgts?: Decimal
  perc_verba_rescisoria_garantia?: Decimal
}
accepted_at: RFC3339
inscricao_empregador?: RailCodePair
if_concessora?: RailCodePair
origem_averbacao?: RailCodePair
origem_exclusao?: RailCodePair
motivo_exclusao?: RailCodePair
situacao_bloqueio_garantia?: RailCodePair
nome_trabalhador?: string
nome_empregador?: string
cnpj_operador?: string
cnpj_empregador_completo?: boolean
valor_troco?: Decimal
competencia_inicio_desconto?: YearMonth
competencia_fim_desconto?: YearMonth
qtd_escrituracoes?: string
qtd_pagamentos?: string
portabilidade_codigo_origem?: string
portabilidade_codigo_proponente?: string
portabilidade_numero_unico_averbacao?: string
portabilidade_numero_unico_exclusao?: string
portabilidade_situacao?: RailCodePair
portabilidade_valor_pago?: Decimal
data_inicio_contrato?: RFC3339
data_fim_contrato?: RFC3339
data_primeiro_desconto?: RFC3339
atualizado_em?: RFC3339
excluido_em?: RFC3339
info_contrato_enviada_em?: RFC3339
}

consignado.averbacao.confirmed

A Dataprev confirma a averbação.Subject: contract_id

type ConsignadoAverbacaoConfirmedV1 = {
contract_id: string
numero_contrato: string
dataprev_success_code: string
averbado_at: RFC3339
}

consignado.averbacao.rejected

A Dataprev rejeita a averbação.Subject: contract_id

type ConsignadoAverbacaoRejectedV1 = {
contract_id: string
numero_contrato: string
error_code: string
error_message: string
}

consignado.contract.registered

O limite imutável de booking do contrato é alcançado.Subject: numero_contrato

type ConsignadoContractRegisteredV1 = {
contract_id: string
numero_contrato: string
numero_proposta?: string
identity: {
  cpf: string
  matricula: string
  codigo_inscricao_empregador: string
  numero_inscricao_empregador: string
}
declared_terms: {
  principal_amount: Decimal
  liberated_amount: Decimal
  installment_amount: Decimal
  installment_count: number
  monthly_interest_rate: Decimal
  annual_interest_rate: Decimal
  cet_monthly: Decimal
  cet_annual: Decimal
  iof_amount: Decimal
  first_deduction_competencia: YearMonth
  contract_start_date: DateOnly
  contract_end_date: DateOnly
  first_deduction_date: DateOnly
  expected_disbursement_date: DateOnly
  loan_product_version: string
  formalization_deadline: RFC3339
  guarantee: {
    tem_garantias: boolean
    valor_saldo_disponivel_garantia_fgts?: Decimal
    valor_multa_rescisoria_garantia_fgts?: Decimal
    perc_verba_rescisoria_garantia?: Decimal
  }
}
rail_terms: {
  principal_amount: Decimal
  liberated_amount: Decimal
  installment_amount: Decimal
  installment_count: number
  monthly_interest_rate: Decimal
  annual_interest_rate: Decimal
  cet_monthly: Decimal
  cet_annual: Decimal
  iof_amount: Decimal
  accepted_at: RFC3339
  guarantee?: {
    tem_garantias: boolean
    valor_saldo_disponivel_garantia_fgts?: Decimal
    valor_multa_rescisoria_garantia_fgts?: Decimal
    perc_verba_rescisoria_garantia?: Decimal
  }
}
margin_snapshot: {
  available_margin: Decimal
  remuneracao_disponivel: Decimal
  as_of: RFC3339
}
signature: {
  binding_method: string
  signed_at: RFC3339
  provider_evidence_ref: string
  ip: string
  icp_brasil: boolean
  analfabeto: boolean
}
artifacts: {
  signed_ccb: {
    digest_sha256: string
    blob_ref: string
  }
  biometrics_documents_pack: {
    digest_sha256: string
    blob_ref: string
  }
}
registration: {
  averbado_at: RFC3339
  response_code: string
  attachment_hash_operacao: string
}
fund_ref?: string
}

consignado.disbursement.confirmed

O cliente confirma que o trabalhador recebeu os recursos.Subject: numero_contrato

type ConsignadoDisbursementConfirmedV1 = {
confirmation_id: UUID
numero_contrato: string
amount: Decimal
paid_at: RFC3339
payment_reference: string
confirmed_at: RFC3339
}

consignado.exclusao.confirmed

A exclusão do contrato alcança um estado terminal bem-sucedido.Subject: numero_contrato

type ConsignadoExclusaoConfirmedV1 = {
fact_id: UUID
tenant_id: string
request_ref: UUID
numero_contrato: string
motivo_exclusao: string
status: "confirmed"
provider_reference?: string
outcome_at: RFC3339
evidence_source: "exclude_response" | "m005_observation" | "operator_evidence"
}

consignado.exclusao.rejected

A exclusão do contrato alcança um estado terminal rejeitado.Subject: numero_contrato

type ConsignadoExclusaoRejectedV1 = {
fact_id: UUID
tenant_id: string
request_ref: UUID
numero_contrato: string
motivo_exclusao: string
status: "rejected"
provider_reference?: string
reason_code?: string
message?: string
outcome_at: RFC3339
evidence_source: "exclude_response" | "operator_evidence"
}

consignado.redirecionamento.confirmed

O redirecionamento é confirmado.Subject: request_ref

type ConsignadoRedirecionamentoConfirmedV1 = {
request_ref: string
numero_contrato: string
source_vinculo_ref: string
target_vinculo_ref: string
target_matricula: string
target_cnpj: string
target_esocial_category: "101" | "104" | "721"
disruption_status: "suspended" | "terminated"
effective_at: RFC3339

provider_reference: string
numero_contrato_novo?: string
outcome_at: RFC3339
}

consignado.redirecionamento.rejected

O redirecionamento é rejeitado.Subject: request_ref

type ConsignadoRedirecionamentoRejectedV1 = {
request_ref: string
numero_contrato: string
source_vinculo_ref: string
target_vinculo_ref: string
target_matricula: string
target_cnpj: string
target_esocial_category: "101" | "104" | "721"
disruption_status: "suspended" | "terminated"
effective_at: RFC3339

reason_code: string
outcome_at: RFC3339
}

consignado.reconciliation.received

Um registro de escrituração, repasse ou CSV de portal é normalizado.Subject: object_ref

type ConsignadoReconciliationReceivedV1 = {
  competencia?: YearMonth
  source_kind: "dataprev_escrituracao" | "dataprev_repasse" | "portal_csv"
  object_ref: string
  records?: RepasseRecord[] | EscrituracaoRecord[]
}

type RepasseRecord = {
  id: string
  numero_guia: string
  numero_contrato: string
  cpf?: string
  matricula?: string
  valor_parcela_paga: Decimal
  codigo_trf: string
  data_repasse_if: RFC3339
  status_repasse: string
  verbas_rescisorias: boolean
  competencia?: YearMonth
  data_hora_inclusao_dataprev?: RFC3339
  valor_multa?: Decimal
  valor_juros_de_mora?: Decimal
  valor_atualizacao_monetaria?: Decimal
}

type EscrituracaoRecord = {
  numero_contrato: string
  cpf?: string
  matricula?: string
  valor_parcela: Decimal
  analise: {
    existe_trabalhador_escriturado: boolean
    existe_numero_contrato_escriturado: boolean
    vinculo_correto: boolean
    instituicao_financeira_correta: boolean
    valor_parcela_correta: boolean
    dados_correspondentes: boolean
  }
  tipo_evento_esocial: {
    codigo: number
    descricao: string
  }
}

consignado.employment_status.reported

Um registro de suspensão ou desligamento empregatício é consultado.Subject: record_id

type ConsignadoEmploymentStatusReportedV1 = {
report_ref: string
record_id: string
numero_contrato: string
status: "suspended" | "terminated"
effective_at: RFC3339
reason_code?: string
}

consignado.afastamento.reported

Um alerta de afastamento ou desligamento do trabalhador é reportado.Subject: SHA-256(payload)

type ConsignadoAfastamentoReportedV1 = {
cpf: string
matricula: string
tipo_alerta_codigo: string
codigo_motivo_afastamento?: string
data_referencia: DateOnly
data_afastamento?: DateOnly
data_termino_afastamento?: DateOnly
codigo_motivo_desligamento?: string
data_desligamento?: DateOnly
data_aviso_previo?: DateOnly
data_fim_aviso_previo?: DateOnly
}

consignado.throughput.changed

O throughput efetivo da Dataprev para um tenant é alterado.Subject: tenant_id

type ConsignadoThroughputChangedV1 = {
tenant_id: string
sequence: number
requests_per_second: number
previous_requests_per_second?: number
changed_at: RFC3339
changed_by: string
}

consignado.cessao.registered

Uma cessão de crédito é registrada no domínio do gateway.Subject: idempotency_key

type ConsignadoCessaoRegisteredV1 = {
tenant_id: string
idempotency_key: string
fundo_ref: string
cedido_at: RFC3339
cedido_by: string
}

consignado.repasse.overdue

Um repasse esperado ultrapassa o prazo ou não possui prazo calculável.Subject: object_ref

type ConsignadoRepasseOverdueV1 = {
object_ref: string
cnpj?: string
numero_contrato: string
competencia: YearMonth
reason: "repasse_missing" | "deadline_uncomputable"
due_at?: RFC3339
observed_at: RFC3339
}

consignado.repasse.resolved

Um movimento resolve um repasse em atraso.Subject: object_ref

type ConsignadoRepasseResolvedV1 = {
object_ref: string
cnpj?: string
numero_contrato: string
competencia: YearMonth
estimated_due_at?: RFC3339
guia_paid_at?: RFC3339
exact_due_at?: RFC3339
repasse_paid_at?: RFC3339
settled_at: RFC3339
}

consignado.repasse.unobserved

O gateway não consegue estabelecer uma observação atual do trilho para as expectativas.Subject: object_ref

type ConsignadoRepasseUnobservedV1 = {
object_ref: string
last_observed_at?: RFC3339
}

consignado.calendar.published

Uma janela do calendário operacional de descontos é publicada.Subject: competencia_consulta

type ConsignadoCalendarPublishedV1 = {
competencia_atual: YearMonth
competencia_consulta: YearMonth
data_inicio_competencia: DateOnly
data_fim_competencia: DateOnly
}

Comandos consumidos do Lender

Estes são comandos de entrada, não eventos emitidos pelo Consignado. Eles chegam em lerian.streaming.lender.commands, com ce-source: lender e ce-type: studio.lerian.lender.<resource>.<event>. A averbação não é um comando do Lender em develop. Envie-a pela operação HTTP autenticada.

Chave de definição	`ce-type`	Comportamento em runtime
`consignado.margin.requested`	`studio.lerian.lender.consignado_margin.requested`	É consumido quando os runtimes da Dataprev e de streaming estão habilitados. O Lender `develop` não tem publicador de produção para esse comando; use a operação HTTP autenticada de margem, a menos que sua implantação forneça um.
`consignado.redirecionamento.requested`	`studio.lerian.lender.consignado_redirecionamento.requested`	O gateway executa a solicitação quando o adaptador de redirecionamento está configurado; caso contrário, retorna uma recusa nomeada que pode ser reprocessada após configurar o adaptador.
`consignado.exclusao.requested`	`studio.lerian.lender.consignado_exclusao.requested`	Executa pelo mesmo serviço idempotente da operação HTTP autenticada quando o runtime de exclusão está habilitado; caso contrário, retorna um erro nomeado de indisponibilidade.

Regras de entrega e compatibilidade

Desduplique por (ce-source, ce-id) e implemente handlers idempotentes.
Para reprocessar uma recusa de redirecionamento da DLQ do consumidor, reentregue o registro de origem identificado por tópico, partição e offset; não publique um novo evento. O ce-id original e o request_ref do redirecionamento permanecem estáveis.
Leia ce-schemaversion antes de decodificar. O schema 1.0.0 viaja no cabeçalho e nunca no tópico.
Valores monetários e taxas são strings decimais. Timestamps usam UTC RFC 3339; valores apenas de data usam YYYY-MM-DD; competências usam YYYYMM.
Subjects do envelope são referências de negócio ou digests de conteúdo e não carregam o CPF do trabalhador.
Chaves de comando de entrada desconhecidas ou não compatíveis são colocadas em quarentena na DLQ do consumidor de Consignado.
A ausência de um identificador de negócio obrigatório impede a publicação ou execução do comando; o valor nunca é sintetizado.

Visão geral

Midaz

Tracer

Lender

Matcher

Reporter

Fetcher

Consignado

Eventos de Consignado

Contrato do fluxo de aplicação

Catálogo de eventos emitidos

Notação dos payloads

Contratos de payload

Comandos consumidos do Lender

Regras de entrega e compatibilidade

​Contrato do fluxo de aplicação

​Catálogo de eventos emitidos

​Notação dos payloads

​Contratos de payload

​Comandos consumidos do Lender

​Regras de entrega e compatibilidade

Contrato do fluxo de aplicação

Catálogo de eventos emitidos

Notação dos payloads

Contratos de payload

Comandos consumidos do Lender

Regras de entrega e compatibilidade