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

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

O Pix Lerian é o plugin de Pix da Lerian. Ele dá à sua instituição o que ela precisa para operar Pix na camada de aplicação. Um único produto unificado cobre orquestração de transações, gestão de chaves, QR Codes, devoluções e resolução de disputas.

O Pix Lerian é **um plugin para 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ão somos um PSP e não somos um PSTI. A conectividade regulada fica abaixo do Pix Lerian. A sua instituição escolhe o que a fornece: um participante direto, um PSTI certificado que você contrata ou o [Lerian SPI](/pt/rails/spi/what-is-lerian-spi). O Lerian SPI é o conector próprio da Lerian com o BACEN, para uma instituição que participa de forma direta.

<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 suporte a Pix em diferentes provedores de conectividade significava manter **plugins separados e isolados**, um por provedor, cada um com a própria base de código, os próprios contratos de API e os próprios padrões de integração. Isso criava problemas:

* **Lógica de negócio duplicada**: cada plugin tinha que implementar e manter as mesmas regras de Pix de forma independente
* **Contratos de API diferentes**: cada integração de provedor expunha uma API diferente para o cliente, o que dificultava trocar ou adicionar provedores
* **Custo de manutenção maior**: você tinha que aplicar correções de bugs, atualizações regulatórias e novos recursos separadamente em cada plugin
* **Sem portabilidade**: mudar de um provedor para outro exigia uma reintegração completa

O Pix Lerian resolve isso centralizando toda a lógica de Pix em um único produto, com uma **API unificada** e uma **camada de adaptação de provedores** que faz a tradução específica de cada provedor. Você tem uma integração para qualquer provedor, sem retrabalho quando as suas necessidades de conectividade mudam.

# O que o Pix Lerian oferece

***

O Pix Lerian oferece uma **camada de orquestração de Pix** que cuida do ciclo de vida de negócio completo das operações de 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 titularidade de chaves Pix
* **Geração de QR Code estático e dinâmico**: emita QR Codes para iniciação de pagamento
* **Orquestração do ciclo de vida do MED**: gerencie o Mecanismo Especial de Devolução (Special Refund Mechanism) de ponta a ponta
* **Tratamento de devoluções**: processe devoluções totais e parciais com o sequenciamento regulatório correto
* **Webhooks, processamento de eventos e workers em segundo plano**: reaja a eventos do provedor em tempo real e execute jobs assíncronos com confiabilidade
* **Integração nativa com o Midaz**: o Midaz é o ledger obrigatório do Pix Lerian, com validação de contas, verificação de saldos, lançamento de débito/crédito e roteamento

# Como funciona

***

O Pix Lerian usa uma **camada de adaptação de provedores** para separar a sua integração das particularidades de qualquer provedor de conectividade.

O plugin expõe uma **API única** para a sua aplicação. Atrás dessa API, um adaptador de provedor traduz cada operação (transações, consultas de chave, registros de QR Code, devoluções) para o protocolo e o formato exigidos pelo provedor que você configurou. A 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 oferecer suporte a modelos de participação adicionais não exige reescrever a sua integração. Você muda a configuração. A API continua a mesma.

<Note>
  O Pix Lerian não fala com o BACEN por conta própria. Ele opera acima da camada de gateway SPI/DICT e cuida da lógica de negócio do Pix. Esse gateway é um **participante direto**, um **PSTI certificado** ou o **Lerian SPI**.
</Note>

# Modelos de participação

***

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

No Pix Lerian, o modelo de participação é uma **configuração**, não um produto diferente. A **camada de adaptação de provedores** oferece suporte aos dois modelos. Você escolhe um provedor que corresponde ao seu status regulatório, e a API do plugin continua a mesma. Trocar de provedor ou evoluir o seu modelo de participação não exige reintegrar o plugin.

# Integrações no ecossistema Lerian

***

O Pix Lerian exige o **Midaz** como ledger central. Essa integração nativa simplifica:

* Validação de contas
* Verificação de saldos
* Lançamento 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 o cliente e de entidades
* **Fees Engine**: cálculo e cobrança automatizados de tarifas
* **Access Manager**: autenticação e autorização

# Modelo de deploy

***

O Pix Lerian é entregue no modelo **BYOC** (Bring Your Own Cloud). A sua instituição faz o deploy e opera os binários fornecidos pela Lerian na própria infraestrutura, em nuvem pública, nuvem 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 é feito para instituições que:

* Participam do arranjo Pix (ou pretendem participar)
* Têm um **ISPB** válido (identificador atribuído pelo BACEN às instituições financeiras no Brasil)
* São donas do ledger no nível de negócio: a sua instituição controla contas e saldos, independentemente de onde a infraestrutura roda

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

**Não é adequado para** instituições em que um terceiro controla o ledger ou a gestão de contas no nível de negócio. Se as suas contas e saldos ficam dentro do domínio de um provedor de BaaS (e não apenas na infraestrutura dele), o Pix Lerian não é a escolha certa. A instituição deve ser dona da camada de ledger no sentido lógico, independentemente do modelo de deploy.

# Requisitos para operar

***

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

* Um **ISPB** válido registrado no BACEN
* **Conectividade com o trilho**. Para participação indireta, um contrato com um participante direto. Para participação direta, um contrato com um PSTI certificado ou o Lerian SPI como conector próprio
* **Propriedade lógica do ledger**: o Midaz deve estar com o deploy feito e operacional, com a sua instituição controlando contas e saldos

**Requisitos adicionais para BYOC:**

* O seu próprio **ambiente em nuvem ou on-premise** para hospedar o plugin
* **Preparo de DevOps e SRE**: a sua equipe gerencia deploy, monitoramento, atualizações e resposta a incidentes
* **Responsabilidade por segurança e compliance**: a sua instituição responde por controle de acesso, redundância, observabilidade e trilhas de auditoria

# Vantagens

***

### Integrações nativas do ecossistema

Conecte-se ao Midaz, ao CRM, ao Fees Engine e ao Access Manager prontos para uso. Cada integração já vem embutida na plataforma.

### Customização

Estenda ou modifique a lógica de negócio 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 várias camadas que adicionam custo sem adicionar controle. No BYOC, dimensione a infraestrutura para a sua demanda real.

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

Rode tudo na sua própria infraestrutura. Aplique as suas políticas de IAM, os seus padrões de criptografia e os seus frameworks de governança. Defina regras de roteamento, políticas de negócio e práticas operacionais. O seu ledger, os seus saldos e os seus dados armazenados ficam no seu ambiente. Como o Pix é um trilho de pagamento, o plugin continua trocando as mensagens de liquidação e de diretório necessárias para mover 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 sai dele.

# Contrapartidas

***

O modelo BYOC tem as seguintes contrapartidas:

* **Exige maturidade técnica**: a sua instituição precisa de capacidade de DevOps, ferramentas de observabilidade e experiência em gestão operacional.
* **Exige disciplina de governança**: a sua equipe deve manter segurança, disponibilidade, compliance e prontidão para auditoria.
* **Mais configuração no início**: flexibilidade significa mais orquestração e parametrização na configuração inicial. Planeje um processo de onboarding estruturado.
* **Responsabilidade operacional**: a sua instituição gerencia atualizações de software, patches, escala e planos de continuidade. A Lerian fornece o software e as ferramentas. A sua equipe opera.

# Referência técnica

***

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

# Casos de uso de Pix com o Midaz

***

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

<CardGroup>
  <Card title="Pix com rotas de transação" icon="route" href="/pt/interfaces/pix/midaz-for-pix-transaction-routes">
    Modele fluxos de transferência Pix validados e reutilizáveis com rotas de transação e rotas de operação, de transferências simples até a cobrança de tarifas.
  </Card>

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