Autorizar e pagar com Pix Automático

Deixe seu cliente autorizar um Pix recorrente e pague cada débito agendado a partir da conta do cliente.

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 pagador. Mostra cada solicitação ao pagador e envia a decisão do pagador.
Pix Lerian. Guarda as autorizações e os débitos agendados do pagador. Debita a conta do pagador no Midaz na data de liquidação.
Midaz. O ledger que guarda a conta do pagador.
Lerian SPI. Troca as mensagens do Pix Automático e os pagamentos com o SPI.
SPI. O sistema de pagamentos instantâneos do BACEN. Leva as mensagens da instituição do recebedor e liquida cada pagamento.

Antes de começar

A conta do pagador existe no Midaz, está ativa e tem um titular.
Seu backend verifica se o pagador pode usar a conta. Envie essa conta em X-Account-Id. Veja Usar o Pix Automático com o Pix Lerian.
Seus sistemas recebem os eventos do Pix Lerian. Veja Eventos do Pix Lerian.

Diagrama

Autorizar

#	Origem	Destino	Mensagem	API da Lerian	O que acontece
1	SPI	Lerian SPI	`pain.009`		A instituição do recebedor pede uma autorização.
2	Lerian SPI	Pix Lerian	Chamada interna		O Lerian SPI repassa a solicitação ao Pix Lerian.
3	Pix Lerian	Pix Lerian	Passo interno		O Pix Lerian encontra a conta do pagador.
4	Pix Lerian	Sua instituição	API da Lerian	Evento `pix_auto_request.received`	A solicitação aguarda a decisão do pagador. Leia-a com `GET /payer/authorization-requests/{authorization_request_id}`.
5	Sua instituição	Sua instituição	Passo interno		Mostre a solicitação ao pagador e obtenha a decisão.
6	Sua instituição	Pix Lerian	API da Lerian	`POST /payer/authorization-requests/{authorization_request_id}/decide`	Envie `decision` `ACCEPT`, com os parâmetros do pagador, se houver. Envie o cabeçalho `X-Idempotency`.
7	Pix Lerian	Sua instituição	API da Lerian	Resposta ao passo 6	O Pix Lerian responde `202` com a solicitação em `ACCEPTED` e o `authorizationId`. A autorização fica `AWAITING_CONCLUSION`. O Pix Lerian publica `pix_auto_authorization.granted` e `pix_auto_authorization.awaiting_conclusion`.
8	Pix Lerian	Lerian SPI	Chamada interna		O Pix Lerian envia o aceite.
9	Lerian SPI	SPI	`pain.012`		O Lerian SPI envia o aceite à instituição do recebedor.
10	SPI	Lerian SPI	`pain.012`		A instituição do recebedor conclui a autorização.
11	Lerian SPI	Pix Lerian	Chamada interna		O Lerian SPI repassa a conclusão ao Pix Lerian.
12	Pix Lerian	Sua instituição	API da Lerian	Evento `pix_auto_authorization.concluded`	O evento traz o resultado. Com `APPROVED`, a autorização está ativa.

Pagar os débitos agendados

#	Origem	Destino	Mensagem	API da Lerian	O que acontece
1	SPI	Lerian SPI	`pain.013`		A instituição do recebedor envia a instrução de um débito.
2	Lerian SPI	Pix Lerian	Chamada interna		O Lerian SPI repassa a instrução ao Pix Lerian.
3	Pix Lerian	Pix Lerian	Passo interno		O Pix Lerian confere a instrução com a autorização e agenda o débito.
4	Pix Lerian	Lerian SPI	Chamada interna		O Pix Lerian aceita ou recusa a instrução.
5	Lerian SPI	SPI	`pain.014`		O Lerian SPI envia a resposta à instituição do recebedor.
6	Pix Lerian	Pix Lerian	Passo interno		Na data de liquidação, entre 00:00 e 08:00, o Pix Lerian inicia o débito.
7	Pix Lerian	Midaz	Chamada interna		O Pix Lerian debita a conta do pagador. A transação credita `@external/BRL`.
8	Pix Lerian	Lerian SPI	Chamada interna		O Pix Lerian envia o pagamento.
9	Lerian SPI	SPI	`pacs.008`		O Lerian SPI envia a ordem de pagamento ao SPI.
10	SPI	Lerian SPI	`pacs.002`		O SPI informa a liquidação ou a rejeição do pagamento.
11	Lerian SPI	Pix Lerian	Chamada interna		O Lerian SPI repassa o resultado ao Pix Lerian.
12	Pix Lerian	Midaz	Chamada interna		Só para um pagamento rejeitado: o Pix Lerian reverte o débito com uma nova transação reversa.
13	Pix Lerian	Sua instituição	API da Lerian	Evento `outbound_transfer.completed`	A transferência tem `initiationType` `AUTO`. Para um pagamento rejeitado, o evento é `outbound_transfer.rejected`.

Regras

Autorizar

Para recusar, envie decision REJECT com rejectionReason. O Pix Lerian publica pix_auto_request.rejected. A instituição do recebedor não responde a uma recusa.
Quando nenhuma conclusão chega em uma hora, o Pix Lerian publica pix_auto_authorization.conclusion_timed_out. A autorização continua aguardando a conclusão.

Pagar os débitos agendados

O Pix Lerian recusa uma instrução acima do valor máximo do pagador (AM02), ou uma que difere de um valor fixo (AM09).
Liste os débitos agendados com GET /payer/scheduled-payments.
O pagador pode cancelar um débito agendado com POST /payer/scheduled-payments/{scheduled_payment_id}/cancel até as 00:00 da data de liquidação. A autorização continua ativa.
Quando a janela de 00:00 a 08:00 fecha sem liquidação, o Pix Lerian publica pix_auto_scheduled_payment.settlement_deferred. Ele tenta de novo no mesmo dia, entre 18:00 e 21:00.
Os horários desta página estão no fuso America/Sao_Paulo.

Como saber que terminou

Autorizar. O Pix Lerian publica pix_auto_authorization.concluded com APPROVED.
Pagar os débitos agendados. Para cada débito, o Pix Lerian publica outbound_transfer.completed com initiationType AUTO.

O que pode dar errado

Situação	O que você vê	O que fazer
A conclusão não chega em uma hora.	Evento `pix_auto_authorization.conclusion_timed_out`.	Avise o pagador que a autorização ainda não está ativa.
O cancelamento de um débito chega às 00:00 da data de liquidação ou depois.	`409`, código `PIX-0825`.	O débito continua agendado.
O débito não foi liquidado naquele dia, e a autorização permite novas tentativas.	Evento `pix_auto_scheduled_payment.settlement_retry_permitted`.	Avise o pagador que novas tentativas podem ocorrer nos próximos dias.
O débito não foi liquidado naquele dia, e a autorização não permite novas tentativas.	Evento `pix_auto_scheduled_payment.settlement_failed`.	Avise o pagador que o Pix Automático não pagou este débito.
A resposta a uma chamada não chega.	Nenhuma resposta, ou um timeout.	Envie a mesma chamada de novo com a mesma chave `X-Idempotency`.

Visão geral

Crédito com garantia

Pagamentos

Liquidação e operação diária

Consignado CLT (Dataprev)

Autorizar e pagar com Pix Automático

Participantes

Antes de começar

Diagrama

Autorizar

Pagar os débitos agendados

Regras

Autorizar

Pagar os débitos agendados

Como saber que terminou

O que pode dar errado

Relacionados

​Participantes

​Antes de começar

​Diagrama

​Autorizar

​Pagar os débitos agendados

​Regras

​Autorizar

​Pagar os débitos agendados

​Como saber que terminou

​O que pode dar errado

​Relacionados

Participantes

Antes de começar

Diagrama

Autorizar

Pagar os débitos agendados

Regras

Autorizar

Pagar os débitos agendados

Como saber que terminou

O que pode dar errado

Relacionados