Eventos de Consignado

Contrato completo de CloudEvents emitido por Lerian Consignado en develop: headers de enrutamiento, disparadores, asuntos, campos de payload y semántica de entrega.

Lerian Consignado tiene 25 definiciones de hechos de negocio para CloudEvents 1.0 a través de lib-streaming v3. De estas, 23 tienen rutas de emisión incondicionales en producción en develop. Consignado emite los dos resultados de portabilidad solo cuando el consumidor de resultados está habilitado y el manifest del gateway desplegado declara el evento. Los hechos emitidos entran al outbox transaccional antes de la publicación.

Los contratos de payload a continuación describen el objeto data del CloudEvent. Una propiedad marcada con ? puede estar ausente. null es válido solo donde un contrato de payload lo escribe explícitamente.

​

Contrato de stream de la aplicación

Elemento del wire	Valor
Tema del hecho	lerian.streaming.consignado-gw
ce-source	consignado-gw
ce-type	studio.lerian.consignado-gw.<resource>.<event>
Clave de despacho	<resource>.<event> de ce-resourcetype y ce-eventtype
ce-schemaversion	1.0.0
Clave de partición	Identificador de tenant
Entrega	Al menos una vez a través del outbox transaccional

El tema identifica la aplicación que produce el evento, no un evento en particular. Enruta por ce-source, ce-resourcetype y ce-eventtype. Usa ce-type como su compuesto calificado por fuente. Nunca infieras un evento a partir del nombre del tema.

​

Catálogo de eventos emitidos

Clave de definición	ce-type	Recurso / evento	ce-subject	Disparador de emisión
consignado.solicitacao.received	studio.lerian.consignado-gw.consignado_solicitacao.received	consignado_solicitacao / received	id_solicitacao	El gateway descubre una solicitud de préstamo abierta en Dataprev.
consignado.portability_proposal.received	studio.lerian.consignado-gw.consignado_portability_proposal.received	consignado_portability_proposal / received	id_solicitacao	El gateway descubre una oferta de portabilidad M011 activa y la registra con su envelope de outbox.
consignado.margin.fetched	studio.lerian.consignado-gw.consignado_margin.fetched	consignado_margin / fetched	request_ref	El gateway lee el margen del trabajador desde Dataprev.
consignado.proposal.accepted	studio.lerian.consignado-gw.consignado_proposal.accepted	consignado_proposal / accepted	proposal_ref	El gateway constata la propuesta aceptada del riel frente a la oferta durable del cliente.
consignado.averbacao.confirmed	studio.lerian.consignado-gw.consignado_averbacao.confirmed	consignado_averbacao / confirmed	contract_id	Dataprev confirma la averbação.
consignado.averbacao.rejected	studio.lerian.consignado-gw.consignado_averbacao.rejected	consignado_averbacao / rejected	contract_id	Dataprev rechaza la averbação.
consignado.contract.registered	studio.lerian.consignado-gw.consignado_contract.registered	consignado_contract / registered	numero_contrato	El registro del contrato alcanza su límite inmutable.
consignado.disbursement.confirmed	studio.lerian.consignado-gw.consignado_disbursement.confirmed	consignado_disbursement / confirmed	numero_contrato	El cliente confirma que el trabajador recibió los fondos.
consignado.contract_correction.available	studio.lerian.consignado-gw.consignado_contract_correction.available	consignado_contract_correction / available	numero_contrato	Un cliente reemplaza el CCB firmado y expone el recurso corregido para su recuperación autenticada.
consignado.disbursement_correction.available	studio.lerian.consignado-gw.consignado_disbursement_correction.available	consignado_disbursement_correction / available	numero_contrato	Un cliente reemplaza una confirmación de pago y expone el recurso corregido para su recuperación autenticada.
consignado.portabilidade.efetivada	studio.lerian.consignado-gw.consignado_portabilidade.efetivada	consignado_portabilidade / efetivada	numero_contrato	Condicionado por el manifest: cuando el consumidor de resultados está habilitado y el manifest del gateway desplegado declara este evento, Dataprev acepta la exclusión de portabilidad del lado de origen de este gateway y el contrato sale de la institución.
consignado.portabilidade.rejeitada	studio.lerian.consignado-gw.consignado_portabilidade.rejeitada	consignado_portabilidade / rejeitada	numero_contrato	Condicionado por el manifest: cuando el consumidor de resultados está habilitado y el manifest del gateway desplegado declara este evento, Dataprev rechaza la exclusión de portabilidad del lado de origen de este gateway.
consignado.exclusao.confirmed	studio.lerian.consignado-gw.consignado_exclusao.confirmed	consignado_exclusao / confirmed	numero_contrato	La exclusión del contrato alcanza un estado terminal exitoso.
consignado.exclusao.rejected	studio.lerian.consignado-gw.consignado_exclusao.rejected	consignado_exclusao / rejected	numero_contrato	La exclusión del contrato alcanza un estado terminal rechazado.
consignado.redirecionamento.confirmed	studio.lerian.consignado-gw.consignado_redirecionamento.confirmed	consignado_redirecionamento / confirmed	request_ref	La redirección alcanza un resultado confirmado.
consignado.redirecionamento.rejected	studio.lerian.consignado-gw.consignado_redirecionamento.rejected	consignado_redirecionamento / rejected	request_ref	La redirección alcanza un resultado rechazado.
consignado.reconciliation.received	studio.lerian.consignado-gw.consignado_reconciliation.received	consignado_reconciliation / received	object_ref	El gateway normaliza un registro contable, de repasse o de CSV de portal.
consignado.employment_status.reported	studio.lerian.consignado-gw.consignado_employment_status.reported	consignado_employment_status / reported	record_id	El gateway lee un registro de suspensión o terminación de empleo.
consignado.afastamento.reported	studio.lerian.consignado-gw.consignado_afastamento.reported	consignado_afastamento / reported	SHA-256(payload)	Se reporta una alerta de ausencia o terminación del trabajador.
consignado.throughput.changed	studio.lerian.consignado-gw.consignado_throughput.changed	consignado_throughput / changed	tenant_id	Cambia el throughput efectivo de Dataprev de un tenant.
consignado.cessao.registered	studio.lerian.consignado-gw.consignado_cessao.registered	consignado_cessao / registered	idempotency_key	Una cesión de crédito se registra en el dominio del gateway.
consignado.repasse.overdue	studio.lerian.consignado-gw.consignado_repasse.overdue	consignado_repasse / overdue	object_ref	Un repasse esperado supera su plazo o no tiene un plazo calculable.
consignado.repasse.resolved	studio.lerian.consignado-gw.consignado_repasse.resolved	consignado_repasse / resolved	object_ref	Un movimiento resuelve un repasse vencido.
consignado.repasse.unobserved	studio.lerian.consignado-gw.consignado_repasse.unobserved	consignado_repasse / unobserved	object_ref	El gateway no puede establecer una observación actual del riel para las expectativas.
consignado.calendar.published	studio.lerian.consignado-gw.consignado_calendar.published	consignado_calendar / published	competencia_consulta	Se publica una ventana operativa del calendario de descuentos.

​

Notación del payload

El wire usa JSON con nombres de propiedad en snake_case. Estos alias describen los formatos que usan los esquemas:

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

El gateway descubre una solicitud de préstamo abierta en Dataprev.

Asunto: 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

El gateway descubre una oferta de portabilidad M011 activa y la registra con su envelope de outbox.

Asunto: 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

El gateway lee el margen del trabajador desde Dataprev.

Asunto: 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

El gateway constata la propuesta aceptada del riel frente a la oferta durable del cliente.

Asunto: 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

Dataprev confirma la averbação.

Asunto: contract_id

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

consignado.averbacao.rejected

Dataprev rechaza la averbação.

Asunto: contract_id

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

consignado.contract.registered

El registro del contrato alcanza su límite inmutable.

Asunto: 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

El cliente confirma que el trabajador recibió los fondos.

Asunto: numero_contrato

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

consignado.contract_correction.available / consignado.disbursement_correction.available

Un cliente reemplaza un CCB firmado o un pago ya confirmado. El payload apunta al recurso corregido. Los consumidores lo recuperan mediante M2M autenticado y verifican su digest SHA-256. El ce-resourcetype del evento distingue el tipo de corrección.

Asunto: numero_contrato

type ConsignadoCorrectionAvailableV1 = {
  numero_contrato: string
  source_authority: string
  resource_uri: string
  resource_digest_sha256: string
  gateway_received_at: RFC3339
  supersedes_event_id?: string
}

consignado.portabilidade.efetivada

Dataprev acepta la propia exclusión de portabilidad del lado de origen de este gateway. El contrato sale de la institución, por lo que la administración de cartera downstream puede detenerse. Este hecho no reporta el lado de la institución receptora y no lleva ningún monto de liquidación.

Asunto: numero_contrato

type ConsignadoPortabilidadeEfetivadaV1 = {
  fact_id: string
  tenant_id: string
  numero_contrato: string
  status: "efetivada"
  destination_institution: string
  external_operation_ref: string
  outcome_at: RFC3339
}

consignado.portabilidade.rejeitada

Dataprev rechaza la propia exclusión de portabilidad del lado de origen de este gateway. El contrato permanece vigente. El payload conserva el código de rechazo publicado y el mensaje acotado.

Asunto: numero_contrato

type ConsignadoPortabilidadeRejeitadaV1 = {
  fact_id: string
  tenant_id: string
  numero_contrato: string
  status: "rejeitada"
  reason_code: string
  message: string
  outcome_at: RFC3339
}

consignado.exclusao.confirmed

La exclusión del contrato alcanza un estado terminal exitoso.

Asunto: 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

La exclusión del contrato alcanza un estado terminal rechazado.

Asunto: 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

La redirección alcanza un resultado confirmado.

Asunto: 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

La redirección alcanza un resultado rechazado.

Asunto: 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

El gateway normaliza un registro contable, de repasse o de CSV de portal.

Asunto: 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

El gateway lee un registro de suspensión o terminación de empleo.

Asunto: 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

Se reporta una alerta de ausencia o terminación del trabajador.

Asunto: 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

Cambia el throughput efectivo de Dataprev de un tenant.

Asunto: 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

Una cesión de crédito se registra en el dominio del gateway.

Asunto: idempotency_key

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

consignado.repasse.overdue

Un repasse esperado supera su plazo o no tiene un plazo calculable.

Asunto: 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

Un movimiento resuelve un repasse vencido.

Asunto: 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

El gateway no puede establecer una observación actual del riel para las expectativas.

Asunto: object_ref

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

consignado.calendar.published

Se publica una ventana operativa del calendario de descuentos.

Asunto: competencia_consulta

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

​

Comandos consumidos desde Lender

Estos son comandos entrantes, no eventos emitidos por Consignado. Llegan en lerian.streaming.lender.commands con ce-source: lender y ce-type: studio.lerian.lender.<resource>.<event>.

La averbação no es un comando de Lender en develop. Envíala mediante la operación HTTP autenticada.

Clave de definición	ce-type	Comportamiento en tiempo de ejecución
consignado.redirecionamento.requested	studio.lerian.lender.consignado_redirecionamento.requested	El gateway ejecuta la solicitud cuando el adaptador de redirección está configurado; en caso contrario, devuelve un rechazo con nombre que puede reproducirse después de la configuración.
consignado.exclusao.requested	studio.lerian.lender.consignado_exclusao.requested	Se ejecuta mediante el mismo servicio idempotente que la operación HTTP autenticada cuando el runtime de exclusión está habilitado; en caso contrario, devuelve un error nombrado de no disponibilidad.

​

Reglas de entrega y compatibilidad

• Deduplica por (ce-source, ce-id) y haz que los handlers sean idempotentes.
• Para reproducir un rechazo de redirección desde el DLQ del consumidor, vuelve a entregar el registro fuente original identificado por su tema, partición y offset. No publiques un nuevo evento. El ce-id original y el request_ref de redirección permanecen estables.
• Lee ce-schemaversion antes de decodificar. El header lleva el esquema 1.0.0, y el tema nunca lo lleva.
• El dinero y las tasas son cadenas decimales. Los timestamps están en UTC, en formato RFC 3339. Los valores de solo fecha usan YYYY-MM-DD, y las competências usan YYYYMM.
• Los asuntos del envelope son referencias de negocio o digests de contenido y no llevan el CPF del trabajador.
• Las claves de comando entrantes desconocidas o no admitidas terminan en el DLQ del consumidor de Consignado.
• La falta de un identificador de negocio obligatorio impide la publicación o la ejecución del comando. Consignado nunca lo genera.