> ## 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

> Pix Lerian é o plugin Pix unificado da Lerian: uma camada de aplicação, qualquer provedor, com orquestração, chaves, QR Codes e disputas.

O Pix Lerian é o plugin Pix da Lerian. Ele oferece à sua instituição o que é necessário para operar o Pix na camada de aplicação -- orquestração de transações, gestão de chaves, QR Codes, devoluções e resolução de disputas -- por meio de um único produto unificado.

A ideia central: **um plugin, qualquer provedor**. Você escolhe o provedor de conectividade que corresponde ao seu modelo de participação. O Pix Lerian cuida do resto.

A Lerian é uma **provedora de tecnologia**. Nós não somos um PSP, não somos um PSTI e não fornecemos conectividade SPI/DICT. A conectividade regulada é sempre realizada por um provedor externo -- seja um participante direto ou um PSTI certificado contratado pela sua instituição.

<Note>
  A arquitetura e os contratos descritos nesta página refletem o design atual do produto Pix Lerian.
</Note>

# Por que o Pix Lerian

***

Historicamente, oferecer Pix com diferentes provedores de conectividade significava manter **plugins separados e isolados** -- um por provedor, cada um com seu próprio código, contratos de API e padrões de integração. Isso criava problemas reais:

* **Lógica de negócio duplicada** -- Cada plugin precisava implementar e manter as mesmas regras do Pix de forma independente
* **Contratos de API diferentes** -- Cada integração com provedor expunha uma API diferente para o cliente, dificultando a troca ou adição de provedores
* **Maior custo de manutenção** -- Você precisava aplicar correções de bugs, atualizações regulatórias e novas funcionalidades separadamente em cada plugin
* **Sem portabilidade** -- Migrar de um provedor para outro exigia uma reintegração completa

O Pix Lerian resolve isso centralizando toda a lógica Pix em um único produto com uma **API unificada** e uma **Provider Adapter Layer** que cuida da tradução específica de cada provedor. O resultado: uma integração, qualquer provedor, sem retrabalho quando suas necessidades de conectividade mudarem.

# O que o Pix Lerian fornece

***

O Pix Lerian entrega uma camada completa de **orquestração Pix** que gerencia todo o ciclo de vida das operações Pix:

* **Fluxos de cash-out e cash-in** -- Envie e receba pagamentos Pix com gestão completa do ciclo de vida das mensagens
* **Gestão de chaves Pix (DICT)** -- Crie, atualize, exclua e resolva a propriedade de chaves Pix
* **Geração de QR Codes estáticos e dinâmicos** -- Emita QR Codes para iniciação de pagamentos
* **Orquestração do ciclo de vida do MED** -- Gerencie o Mecanismo Especial de Devolução de ponta a ponta
* **Tratamento de devoluções** -- Processe devoluções totais e parciais com sequenciamento regulatório adequado
* **Webhooks, processamento de eventos e workers em background** -- Reaja a eventos do provedor em tempo real e execute jobs assíncronos de forma confiável
* **Integração nativa com o Midaz** -- O Midaz é o ledger obrigatório para o Pix Lerian, fornecendo validação de contas, verificação de saldos, lançamentos de débito/crédito e roteamento

# Como funciona

***

O Pix Lerian utiliza uma **Camada de Adaptação de Provedores** para separar sua integração das especificidades de qualquer provedor de conectividade individual.

O plugin expõe uma **API única** para sua aplicação. Por trás dessa API, um adaptador de provedor traduz cada operação -- transações, consultas de chaves, registros de QR Code, devoluções -- no protocolo e formato exigidos pelo provedor configurado. Sua instituição seleciona qual provedor usar durante a configuração. O plugin resolve todo o resto.

Essa arquitetura significa que trocar de provedor ou suportar modelos de participação adicionais não requer reescrever sua integração. Você altera a configuração. A API permanece a mesma.

<Note>
  A conectividade regulada é sempre externa. O Pix Lerian não se conecta ao BACEN diretamente. Um **participante direto** ou um **PSTI certificado** fornece a camada de gateway SPI/DICT. O Pix Lerian opera acima dessa camada, gerenciando toda a lógica de negócios do Pix.
</Note>

# Modelos de participação

***

O BACEN define dois modelos regulatórios de participação no Pix: **direto** (sua instituição se conecta ao BACEN por conta própria) e **indireto** (você se conecta por meio de um participante direto licenciado). Para uma explicação detalhada de cada modelo, consulte [O que é Pix?](/pt/rails/pix/pix-overview).

No Pix Lerian, o modelo de participação é uma **configuração** -- não um produto diferente. Ambos os modelos são suportados pela **Provider Adapter Layer**. Você escolhe um provedor que corresponda ao seu status regulatório, e a API do plugin permanece a mesma. Trocar de provedor ou evoluir seu modelo de participação não exige reintegração.

# Integrações no ecossistema Lerian

***

O Pix Lerian requer o **Midaz** como seu ledger principal. Essa integração nativa simplifica:

* Validação de contas
* Verificação de saldos
* Lançamentos de débito/crédito
* Roteamento
* Regras de negócio (tarifas, autorizações)

O Pix Lerian também se conecta com outros produtos do ecossistema Lerian:

* **CRM (Midaz CRM)** -- Gestão de relacionamento com clientes e entidades
* **Fees Engine** -- Cálculo e cobrança automatizada de tarifas
* **Access Manager** -- Autenticação e autorização

# Modelo de implantação

***

O Pix Lerian é entregue no modelo **BYOC** (Bring Your Own Cloud). Sua instituição implanta e opera os binários fornecidos pela Lerian na própria infraestrutura — em cloud pública, cloud privada ou on-premises.

A sua equipe é responsável pela operação da infraestrutura; a Lerian fornece o software, as atualizações e o suporte acordado.

# Público-alvo

***

O Pix Lerian é projetado para instituições que:

* Participam do arranjo Pix (ou pretendem participar)
* Possuem um **ISPB** válido (identificador atribuído pelo BACEN a instituições financeiras no Brasil)
* São proprietárias do ledger no nível de negócio -- sua instituição controla contas e saldos, independentemente de onde a infraestrutura é executada

O Pix Lerian é voltado a instituições preparadas para operar o produto no modelo BYOC.

**Não adequado para** instituições onde um terceiro controla o ledger ou a gestão de contas no nível de negócio. Se suas contas e saldos residem dentro do domínio de um provedor BaaS -- não apenas de sua infraestrutura -- o Pix Lerian não é a opção adequada. A instituição deve ser proprietária da camada de ledger no nível lógico, independentemente do modelo de implantação.

# Requisitos para operar

***

Antes de adotar o Pix Lerian, sua instituição deve possuir:

* Um **ISPB** válido registrado no BACEN
* Um **contrato com um provedor de conectividade** -- um participante direto (para participação indireta) ou um PSTI certificado (para participação direta), dependendo do seu modelo regulatório
* **Propriedade lógica do ledger** -- o Midaz deve estar implantado e operacional, com sua instituição controlando contas e saldos

**Requisitos adicionais para BYOC:**

* Seu próprio **ambiente cloud ou on-premise** para hospedar o plugin
* **Prontidão de DevOps e SRE** -- sua equipe gerencia implantação, monitoramento, atualizações e resposta a incidentes
* **Propriedade de segurança e conformidade** -- sua instituição é responsável por controle de acesso, redundância, observabilidade e trilhas de auditoria

# Vantagens

***

### Integrações nativas ao ecossistema

Conecte-se ao Midaz, CRM, Fees Engine e Access Manager de forma nativa. Cada integração é construída na plataforma.

### Customização

Estenda ou modifique a lógica de negócios para atender aos requisitos específicos da sua instituição. Adapte-se a mudanças regulatórias no seu próprio ritmo.

### Eficiência econômica

Elimine a dependência de intermediários em múltiplas camadas que adicionam custo sem adicionar controle. No BYOC, dimensione a infraestrutura para sua demanda real.

### Controle total e soberania de dados (BYOC)

Execute tudo na sua própria infraestrutura. Aplique suas próprias políticas de IAM, padrões de criptografia e frameworks de governança. Defina regras de roteamento, políticas de negócio e práticas operacionais. Seu ledger, seus saldos e seus dados armazenados permanecem no seu ambiente. Como o Pix é um rail de pagamento, o plugin ainda troca as mensagens de liquidação e de diretório necessárias para movimentar dinheiro com o sistema de pagamentos brasileiro (a rede RSFN operada pelo Banco Central) — diretamente ou através do seu provedor de participação. Ser dono do ambiente significa que você é dono dos dados e da infraestrutura, não que nenhum tráfego saia dele.

# Trade-offs

***

O modelo BYOC traz os seguintes trade-offs:

* **Requer maturidade técnica** -- Sua instituição precisa de capacidades de DevOps, ferramentas de observabilidade e expertise em gestão operacional.
* **Requer disciplina de governança** -- Segurança, uptime, conformidade e prontidão para auditoria devem ser mantidos pela sua equipe.
* **Mais configuração inicial** -- Flexibilidade significa mais orquestração e parametrização durante a configuração inicial. Planeje um processo estruturado de onboarding.
* **Responsabilidade operacional** -- Sua instituição gerencia atualizações de software, patches, escalabilidade e planos de continuidade. A Lerian fornece o software e as ferramentas -- sua equipe o opera.

# Referência técnica

***

* [**Endpoints DICT**](/pt/reference/pix-lerian/dict/create-entry) — chaves Pix, reivindicações, infrações, devoluções e recuperação de valores.
* [**Endpoints SPI**](/pt/reference/pix-lerian/spi/initiate-transfer) — transferências Pix e devoluções.
* [**Endpoints COB**](/pt/reference/pix-lerian/cob/create-immediate-collection) — cobranças imediatas, cobranças com vencimento e BR Codes.
* [**Variáveis de ambiente**](/pt/rails/pix/pix-lerian-environment-variables) — configuração do binário entregue para implantação BYOC.

# Casos de uso do Pix com o Midaz

***

Veja como o Pix Lerian e o Midaz trabalham juntos na prática:

<CardGroup>
  <Card title="Pix com Rotas de Transação" icon="route" href="/pt/rails/pix/midaz-for-pix-transaction-routes">
    Modele fluxos de transferência Pix validados e reutilizáveis usando Rotas de Transação e Rotas de Operação -- de transferências simples a cobrança de tarifas.
  </Card>

  <Card title="Pix com tarifas automatizadas" icon="calculator" href="/pt/rails/pix/midaz-for-pix-with-fees">
    Combine o Pix Lerian com o Fees Engine para gestão de tarifas transparente e automatizada em fintechs e marketplaces.
  </Card>
</CardGroup>
