Skip to main content
Pix Lerian v1.0.0 is a plugin for integrating Pix business flows with Midaz. It exposes DICT, SPI, COB, and Pix Automático APIs and records the money movement required by each supported flow in Midaz.
This release supports integration and testing with the supplied mock provider. It does not make a native rail connector available for use and does not promise production connectivity through an arbitrary provider.

​
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, mock, and rail connectivity

The plugin is the application layer. It owns its local operation state and calls Midaz for ledger work. The supplied mock provider simulates the external side and sends asynchronous callbacks so you can test the complete integration path. Native SPI messaging integration is a separate connectivity capability. It is not available for use in this v1.0.0 integration path. 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 a technology plugin 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. This v1.0.0 documentation covers the plugin and its mock-provider test path. It does not cover native SPI messaging integration. 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. The mock provider is the supported external-side simulator for v1.0.0 integration testing.

​
Choose a functional path

​
API reference

Use the generated reference for request and response schemas: The functional guides explain sequencing and ownership. The API reference remains the contract for field validation and per-operation responses.