Pix Lerian

Use the Pix Lerian interface to connect Midaz to Lerian SPI for Pix keys, payments, collections, and dispute flows.

Pix Lerian is the interface that connects Midaz to Lerian SPI, Lerian’s own Pix messaging. It exposes DICT, SPI, COB, and Pix Automático APIs and records the money movement required by each supported flow in Midaz.

What the plugin does

• DICT: manage Pix keys, claims, MED 2.0 cases, fraud markers, and VSync reconciliation.
• SPI: initiate cash-outs, process payments, schedule payments, receive adapter callbacks, create refunds, and manage MED 2.0 balance holds.
• COB: create static BR Codes plus immediate and due-date collections.
• Pix Automático: decide recurring-payment authorization requests for the payer, manage authorizations, and cancel scheduled debits.
• Midaz integration: validate the account context and create the debit, credit, hold, release, or reversal required by the flow.

Start with Integrating with Pix Lerian, then use the functional guides for DICT, SPI, COB, and Pix Automático.

Plugin, adapter, and rail

The plugin is the application layer. It owns its local operation state and calls Midaz for ledger work. It calls a connectivity adapter for the provider side. The adapter sends asynchronous callbacks to the plugin.

The Lerian connectivity adapter calls Lerian SPI. The supplied mock provider simulates the provider side for integration tests. Do not use the mock as evidence that a production provider or direct participation has been certified or enabled.

Who uses Pix Lerian

Pix Lerian is an interface for institutions that own their ledger and account rules. It is not a PSP or a PSTI. The institution remains responsible for its regulatory participation and connectivity arrangement.

Midaz is mandatory for the plugin’s account validation and accounting effects. The plugin coordinates the Pix operation and records the corresponding debit, credit, hold, release, or reversal through Midaz. The plugin does not replace the institution’s ledger.

Deployment model

Deploy Pix Lerian in the institution’s BYOC environment and operate its dependencies there. Your team owns deployment, observability, access control, and continuity.

Choose a functional path

Need	Start here
Register, resolve, or move a Pix key	DICT guide
Send a Pix, receive a cash-in, or return a transfer	SPI guide
Create a QR payload or a collection	COB guide
Accept or reject a recurring-payment authorization as the payer	Pix Automático guide
Understand request headers, replays, and callback boundaries	Integration guide
Observe asynchronous states and recover failures	Operations guide

API reference

Use the generated reference for request and response schemas:

• DICT endpoints
• SPI transfer endpoints
• COB immediate collection endpoints
• Pix Automático endpoints
• Pix Lerian errors

The functional guides explain sequencing and ownership. The API reference remains the contract for field validation and per-operation responses.