Este flujo es una lectura sugerida de los manuales del BACEN para Pix. Los manuales prevalecen sobre esta página. Tu institución, como participante, valida el flujo y lo implementa sobre las API de Lerian. Consulta cómo leer los diagramas.
Participantes
- Tu institución. El participante de Pix del receptor. Llama a la API de Pix Lerian, muestra el código QR y recibe los eventos.
- Pix Lerian. Crea el cobro y sigue su estado. Acredita el pago en Midaz.
- Midaz. El ledger que guarda la cuenta que recibe el pago.
- Lerian SPI. Registra el cobro, lo entrega a la institución del pagador e intercambia los mensajes de Pix con el SPI.
- SPI. El sistema de pagos instantáneos del BACEN. Liquida el pago.
- Institución del pagador. El participante de Pix del pagador. Lee el cobro y envía el pago.
Antes de empezar
- La cuenta que recibe el pago tiene una clave Pix activa que tu institución registró en Pix Lerian.
- Tus sistemas reciben los eventos de Pix Lerian. Consulta Eventos de Pix Lerian.
Diagrama
Pasos
Reglas
- Un cobro no crea ninguna transacción en Midaz. El dinero llega como un Pix recibido, con su propio evento
inbound_transfer.completed. - Un nuevo cobro necesita una nueva clave
X-Idempotencyy un nuevotxId. - Un cobro con vencimiento sigue los mismos pasos. Créalo con
POST /collections/duedate. Su eventocollection.paidtienetypeDUE_DATE. - Para terminar un cobro inmediato no pagado, cancélalo con
DELETE /collections/immediate/{id}. El cobro queda enCANCELLED.
Cómo saber que terminó
Pix Lerian publica
collection.paid, y GET /collections/immediate/{id} muestra el cobro en COMPLETED.
Qué puede salir mal
La lista de errores de Pix Lerian describe cada código.