Lerian SPI events

Lerian SPI publishes business facts as CloudEvents 1.0 in binary content mode. Each of its four binaries, spi, dict, brcode, and core, publishes under its own ce-source on its own topic. Streaming Hub delivers these events to your institution’s systems. The event streaming overview describes the shared envelope.

​

How the events reach you

---

• Streaming Hub. The hub reads the lerian.streaming.<ce-source> topics and delivers each matching event to your subscriptions. See How Streaming Hub works.
• One exception. The seven dict_med_operations events travel on the topic br-spi.dict.med.operations. Streaming Hub does not read that topic, so it does not deliver them. Read them with your own Kafka consumer.
• Subscribe by catalog key. A subscription’s event_types takes the eventKey of the Streaming Hub catalog (GET /v1/catalog). For these events, the key is the last two segments of the ce-type, for example spi_payment.settled. See Managing subscriptions.
• Pin the origin for settlements. Lerian SPB also publishes settlement.settled and settlement.failed. To receive only the Lerian SPI settlements on a webhook or queue subscription, set the subscription origin to br-spi-core.
• At least once. An event can arrive more than once. Deduplicate on the (ce-source, ce-id) pair.
• Do not rely on arrival order. Order events by their lifecycle, not by the order in which they arrive.
• Fixed headers. Every event carries ce-tenantid default, ce-schemaversion 1.0.0, and ce-datacontenttype application/json.

​

Streaming manifest

---

Each binary serves its manifest at GET /v1/streaming/manifest. The manifest lists the events that the binary publishes, with the key, resource, event, and schema version of each one. The route requires the Access Manager resource streaming with the action read.

​

Catalog

---

Every ce-type has the form studio.lerian.<ce-source>.<resource>.<event>. The tables give the full value.

​

spi: payments, messages, and approvals

​

Payments

​

Returns

​

Settlement on the rail

​

Pix Automático

​

Messages, reports, and participants

​

Approvals and operations

​

dict: Pix keys, claims, and MED

​

Keys

​

Claims

​

MED records

The rail emits a MED record event when it observes a new version of the record at BACEN. The event names the status that the record reached. updated means that the record changed and its status did not.

​

Statistics and CID set files

​

MED operations

These events travel on the topic br-spi.dict.med.operations, which Streaming Hub does not read.

​

brcode: charges and recurrences

​

Charges

​

Recurrences, recurring charges, and requests

Each of these resources emits one event for each status that it reaches.

​

core: participants and settlements