> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Pix Lerian

> Use a interface Pix Lerian para conectar o Midaz ao Lerian SPI em chaves Pix, pagamentos, cobranças e fluxos de disputa.

O Pix Lerian é a interface que conecta o Midaz ao [Lerian SPI](https://docs.lerian.studio/pt/rails/spi/what-is-lerian-spi.md), a mensageria Pix própria da Lerian. Ele expõe APIs DICT, SPI, COB e Pix Automático e registra no Midaz a movimentação financeira necessária para cada fluxo compatível.

## O que o plugin faz

* **DICT:** gerenciar chaves Pix, reivindicações, casos de MED 2.0, marcadores de fraude e conciliação do VSync.
* **SPI:** iniciar saques, processar pagamentos, agendar pagamentos, receber callbacks do adaptador, criar devoluções, creditar um Pix recebido cujo crédito no ledger está estacionado e gerenciar bloqueios cautelares (retenções de saldo) do MED 2.0.
* **COB:** criar BR Codes estáticos e cobranças imediatas e com vencimento.
* **Pix Automático:** decidir solicitações de autorização de pagamentos recorrentes pelo pagador, gerenciar autorizações e cancelar débitos agendados.
* **Integração com o Midaz:** validar o contexto da conta e criar o débito, crédito, retenção, liberação ou estorno exigido pelo fluxo.

Comece por [Integrar com o Pix Lerian](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-integration.md) e depois use os guias funcionais de [DICT](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-dict.md), [SPI](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-spi.md), [COB](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-cob.md) e [Pix Automático](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-pix-automatico.md).

## Plugin, adaptador e trilho

O plugin é a camada de aplicação. Ele mantém o estado local das operações e chama o Midaz para o trabalho contábil. Ele chama um adaptador de conectividade para o lado do provedor. O adaptador envia callbacks assíncronos ao plugin.

O adaptador de conectividade Lerian chama o Lerian SPI. O provedor simulado fornecido simula o lado do provedor para testes de integração. Não use o mock como evidência de que um provedor de produção ou a participação direta estão certificados ou habilitados.

## Quem usa o Pix Lerian

O Pix Lerian é uma interface para instituições que controlam o próprio ledger e as próprias regras de conta. Ele não é um PSP nem um PSTI. A instituição continua responsável pela sua participação regulatória e pelo seu arranjo de conectividade.

O Midaz é obrigatório para a validação de contas e os efeitos contábeis do plugin. O plugin coordena a operação Pix e registra o débito, crédito, retenção, liberação ou estorno correspondente por meio do Midaz. O plugin não substitui o ledger da instituição.

Um Pix recebido nunca paga tarifa. O Pix Lerian pede ao Midaz que dispense as tarifas em cada crédito de Pix recebido, e o Midaz só atende o pedido quando a configuração `overrides.allowFeeSkip` está ligada no ledger do Pix. Com a configuração desligada, o Midaz recusa o crédito de cada Pix recebido e o Pix Lerian estaciona o crédito: veja [Usar o SPI com o Pix Lerian](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-spi.md).

## Modelo de deploy

Faça o deploy do Pix Lerian no ambiente BYOC da instituição e opere as dependências nesse ambiente. Sua equipe é responsável pelo deploy, pela observabilidade, pelo controle de acesso e pela continuidade.

## Escolha um caminho funcional

| Necessidade | Comece aqui |
| - | - |
| Registrar, resolver ou mover uma chave Pix | [Guia de DICT](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-dict.md) |
| Enviar um Pix, receber uma entrada ou devolver uma transferência | [Guia de SPI](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-spi.md) |
| Criar um payload de QR ou uma cobrança | [Guia de COB](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-cob.md) |
| Aceitar ou rejeitar uma autorização de pagamento recorrente como pagador | [Guia de Pix Automático](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-pix-automatico.md) |
| Entender cabeçalhos de requisição, replays e limites de callback | [Guia de integração](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-integration.md) |
| Observar estados assíncronos e recuperar falhas | [Guia de operação](https://docs.lerian.studio/pt/interfaces/pix-lerian/pix-lerian-operations.md) |

## Referência da API

Use a referência gerada para consultar os schemas de requisição e resposta:

* [Endpoints de DICT](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/dict/create-entry.md)
* [Endpoints de transferência do SPI](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/spi/initiate-transfer.md)
* [Endpoints de cobrança imediata do COB](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/cob/create-immediate-collection.md)
* [Endpoints de Pix Automático](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/pix-automatico/decide-authorization-request.md)
* [Erros do Pix Lerian](https://docs.lerian.studio/pt/reference/interfaces/pix-lerian/pix-lerian-error-list.md)

Os guias funcionais explicam o sequenciamento e a responsabilidade. A referência da API continua sendo o contrato para a validação de campos e as respostas de cada operação.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.