Este fluxo é uma leitura sugerida dos manuais do BACEN para o Pix. Os manuais prevalecem sobre esta página. Sua instituição, como participante, valida o fluxo e o implementa sobre as APIs da Lerian. Veja como ler os diagramas.
Participantes
- Sua instituição. O participante do Pix do recebedor. Chama a API do Pix Lerian, mostra o QR code e recebe os eventos.
- Pix Lerian. Cria a cobrança e acompanha o status dela. Credita o pagamento no Midaz.
- Midaz. O ledger que guarda a conta que recebe o pagamento.
- Lerian SPI. Registra a cobrança, a serve para a instituição do pagador e troca as mensagens do Pix com o SPI.
- SPI. O sistema de pagamentos instantâneos do BACEN. Liquida o pagamento.
- Instituição do pagador. O participante do Pix do pagador. Lê a cobrança e envia o pagamento.
Antes de começar
- A conta que recebe o pagamento tem uma chave Pix ativa que sua instituição registrou no Pix Lerian.
- Seus sistemas recebem os eventos do Pix Lerian. Veja Eventos do Pix Lerian.
Diagrama
Passo a passo
Regras
- Uma cobrança não cria nenhuma transação no Midaz. O dinheiro chega como um Pix recebido, com o próprio evento
inbound_transfer.completed. - Uma nova cobrança precisa de uma nova chave
X-Idempotencye de um novotxId. - Uma cobrança com vencimento segue os mesmos passos. Crie-a com
POST /collections/duedate. O eventocollection.paiddela temtypeDUE_DATE. - Para encerrar uma cobrança imediata não paga, cancele-a com
DELETE /collections/immediate/{id}. A cobrança ficaCANCELLED.
Como saber que terminou
O Pix Lerian publica
collection.paid, e GET /collections/immediate/{id} mostra a cobrança em COMPLETED.
O que pode dar errado
A lista de erros do Pix Lerian descreve cada código.