Consignado events

Lerian Consignado emits 21 business facts as CloudEvents 1.0 through lib-streaming v3. Every fact below has a production emission site on develop and enters the transactional outbox before publication.

The payload contracts below describe the CloudEvent data object. A property marked with ? may be omitted. null is only allowed where it is written explicitly.

Application-stream contract

Wire element	Value
Fact topic	`lerian.streaming.consignado-gw`
`ce-source`	`consignado-gw`
`ce-type`	`studio.lerian.consignado-gw.<resource>.<event>`
Dispatch key	`<resource>.<event>` from `ce-resourcetype` and `ce-eventtype`
`ce-schemaversion`	`1.0.0`
Partition key	Tenant identifier
Delivery	At least once through the transactional outbox

The topic identifies the producing application, not one event. Route by ce-source, ce-resourcetype, and ce-eventtype; use ce-type as their source-qualified composite. Never infer an event from the topic name.

Emitted-event catalog

Definition key	`ce-type`	Resource / event	`ce-subject`	Emission trigger
`consignado.solicitacao.received`	`studio.lerian.consignado-gw.consignado_solicitacao.received`	`consignado_solicitacao` / `received`	`id_solicitacao`	An open loan request is discovered in Dataprev.
`consignado.portability_proposal.received`	`studio.lerian.consignado-gw.consignado_portability_proposal.received`	`consignado_portability_proposal` / `received`	`id_solicitacao`	A live M011 portability offer is discovered and recorded with its outbox envelope.
`consignado.margin.fetched`	`studio.lerian.consignado-gw.consignado_margin.fetched`	`consignado_margin` / `fetched`	`request_ref`	Worker margin is read from Dataprev.
`consignado.proposal.accepted`	`studio.lerian.consignado-gw.consignado_proposal.accepted`	`consignado_proposal` / `accepted`	`proposal_ref`	The accepted rail proposal is witnessed against the durable client bid.
`consignado.averbacao.confirmed`	`studio.lerian.consignado-gw.consignado_averbacao.confirmed`	`consignado_averbacao` / `confirmed`	`contract_id`	Dataprev confirms averbação.
`consignado.averbacao.rejected`	`studio.lerian.consignado-gw.consignado_averbacao.rejected`	`consignado_averbacao` / `rejected`	`contract_id`	Dataprev rejects averbação.
`consignado.contract.registered`	`studio.lerian.consignado-gw.consignado_contract.registered`	`consignado_contract` / `registered`	`numero_contrato`	The immutable contract-booking boundary is reached.
`consignado.disbursement.confirmed`	`studio.lerian.consignado-gw.consignado_disbursement.confirmed`	`consignado_disbursement` / `confirmed`	`numero_contrato`	The client confirms that the worker received the funds.
`consignado.exclusao.confirmed`	`studio.lerian.consignado-gw.consignado_exclusao.confirmed`	`consignado_exclusao` / `confirmed`	`numero_contrato`	Contract exclusion reaches a successful terminal state.
`consignado.exclusao.rejected`	`studio.lerian.consignado-gw.consignado_exclusao.rejected`	`consignado_exclusao` / `rejected`	`numero_contrato`	Contract exclusion reaches a rejected terminal state.
`consignado.redirecionamento.confirmed`	`studio.lerian.consignado-gw.consignado_redirecionamento.confirmed`	`consignado_redirecionamento` / `confirmed`	`request_ref`	Redirection is confirmed.
`consignado.redirecionamento.rejected`	`studio.lerian.consignado-gw.consignado_redirecionamento.rejected`	`consignado_redirecionamento` / `rejected`	`request_ref`	Redirection is rejected.
`consignado.reconciliation.received`	`studio.lerian.consignado-gw.consignado_reconciliation.received`	`consignado_reconciliation` / `received`	`object_ref`	One bookkeeping, repasse, or portal CSV record is normalized.
`consignado.employment_status.reported`	`studio.lerian.consignado-gw.consignado_employment_status.reported`	`consignado_employment_status` / `reported`	`record_id`	An employment suspension or termination record is read.
`consignado.afastamento.reported`	`studio.lerian.consignado-gw.consignado_afastamento.reported`	`consignado_afastamento` / `reported`	`SHA-256(payload)`	A worker absence or termination alert is reported.
`consignado.throughput.changed`	`studio.lerian.consignado-gw.consignado_throughput.changed`	`consignado_throughput` / `changed`	`tenant_id`	A tenant’s effective Dataprev throughput changes.
`consignado.cessao.registered`	`studio.lerian.consignado-gw.consignado_cessao.registered`	`consignado_cessao` / `registered`	`idempotency_key`	A credit assignment is registered in the gateway domain.
`consignado.repasse.overdue`	`studio.lerian.consignado-gw.consignado_repasse.overdue`	`consignado_repasse` / `overdue`	`object_ref`	An expected repasse passes its deadline or has no computable deadline.
`consignado.repasse.resolved`	`studio.lerian.consignado-gw.consignado_repasse.resolved`	`consignado_repasse` / `resolved`	`object_ref`	A movement resolves an overdue repasse.
`consignado.repasse.unobserved`	`studio.lerian.consignado-gw.consignado_repasse.unobserved`	`consignado_repasse` / `unobserved`	`object_ref`	The gateway cannot establish a current rail observation for the expectations.
`consignado.calendar.published`	`studio.lerian.consignado-gw.consignado_calendar.published`	`consignado_calendar` / `published`	`competencia_consulta`	An operational deduction-calendar window is published.

Payload notation

The wire uses JSON with snake_case property names. These aliases describe the formats used by the schemas:

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

Payload contracts

consignado.solicitacao.received

An open loan request is discovered in 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

A live M011 portability offer is discovered and recorded with its outbox envelope.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

Worker margin is read from 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

The accepted rail proposal is witnessed against the durable client bid.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

Dataprev confirms averbação.Subject: contract_id

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

consignado.averbacao.rejected

Dataprev rejects averbação.Subject: contract_id

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

consignado.contract.registered

The immutable contract-booking boundary is reached.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

The client confirms that the worker received the funds.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

Contract exclusion reaches a successful terminal state.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

Contract exclusion reaches a rejected terminal state.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

Redirection is confirmed.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

Redirection is rejected.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

One bookkeeping, repasse, or portal CSV record is normalized.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

An employment suspension or termination record is read.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

A worker absence or termination alert is reported.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

A tenant’s effective Dataprev throughput changes.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

A credit assignment is registered in the gateway domain.Subject: idempotency_key

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

consignado.repasse.overdue

An expected repasse passes its deadline or has no computable deadline.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

A movement resolves an overdue repasse.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

The gateway cannot establish a current rail observation for the expectations.Subject: object_ref

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

consignado.calendar.published

An operational deduction-calendar window is published.Subject: competencia_consulta

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

Commands consumed from Lender

These are inbound commands, not events emitted by Consignado. They arrive on lerian.streaming.lender.commands with ce-source: lender and ce-type: studio.lerian.lender.<resource>.<event>. Averbação is not a Lender command on develop. Submit it through the authenticated HTTP operation.

Definition key	`ce-type`	Runtime behavior
`consignado.margin.requested`	`studio.lerian.lender.consignado_margin.requested`	Consumed when both the Dataprev and streaming runtimes are enabled. Lender `develop` has no production publisher for this command; use the authenticated HTTP margin operation unless your deployment provides one.
`consignado.redirecionamento.requested`	`studio.lerian.lender.consignado_redirecionamento.requested`	The gateway executes the request when the redirection adapter is configured; otherwise it returns a named refusal that can be replayed after configuration.
`consignado.exclusao.requested`	`studio.lerian.lender.consignado_exclusao.requested`	Executes through the same idempotent service as the authenticated HTTP operation when the exclusion runtime is enabled; otherwise it returns a named unavailable error.

Delivery and compatibility rules

Deduplicate by (ce-source, ce-id) and make handlers idempotent.
To replay a redirection refusal from the consumer DLQ, redeliver the original source record identified by its topic, partition, and offset; do not publish a new event. The original ce-id and redirection request_ref remain stable.
Read ce-schemaversion before decoding. Schema 1.0.0 is carried in the header and never in the topic.
Money and rates are decimal strings. Timestamps are UTC RFC 3339; date-only values use YYYY-MM-DD; competências use YYYYMM.
Envelope subjects are business references or content digests and do not carry the worker CPF.
Unknown or unsupported inbound command keys are quarantined in the Consignado consumer DLQ.
A missing required business identifier prevents publication or command execution; it is never synthesized.

Overview

Midaz

Tracer

Lender

Matcher

Reporter

Fetcher

Consignado

Consignado events

Application-stream contract

Emitted-event catalog

Payload notation

Payload contracts

Commands consumed from Lender

Delivery and compatibility rules

​Application-stream contract

​Emitted-event catalog

​Payload notation

​Payload contracts

​Commands consumed from Lender

​Delivery and compatibility rules

Application-stream contract

Emitted-event catalog

Payload notation

Payload contracts

Commands consumed from Lender

Delivery and compatibility rules