Saltar al contenido principal
Tu aplicación llama a las API públicas de DICT, SPI, COB y Pix Automático. El plugin llama a Midaz y a un adaptador de conectividad: el adaptador de conectividad Lerian para Lerian SPI o el proveedor mock para las pruebas de integración. El adaptador devuelve callbacks asíncronos al plugin.
Las rutas de callbacks son exclusivas del adaptador. No las llames desde una aplicación cliente.

Crea tu ruta de integración

  1. Despliega las dependencias del plugin, incluidos Midaz y el adaptador de conectividad de tu entorno.
  2. Obtén un token de acceso cuando la autenticación esté habilitada e identifica la cuenta que posee cada solicitud.
  3. Ejecuta un flujo público: una clave, una transferencia o un cobro.
  4. Conserva el identificador de operación que devuelve la solicitud de creación. Lee esa operación hasta que alcance un estado terminal después del callback del adaptador.
  5. Registra juntos la contabilización de Midaz y el resultado de la operación.

Convenciones de solicitud

Usa la referencia de cada operación como autoridad final. Estas convenciones se repiten en todo el plugin: Un header de idempotencia ausente o no válido es un error del cliente. Reutilizar una clave con un payload diferente es un fallo de precondición, excepto cuando creas un cobro inmediato o con fecha de vencimiento: esas dos rutas devuelven el cobro existente con 200.

Lee el estado después de una escritura asíncrona

Una solicitud correcta puede significar que el plugin aceptó el trabajo, no que el pago o el cobro externo terminó. Para SPI, usa el identificador de transferencia o devolución devuelto con el endpoint de lectura de transferencia o devolución. Para los cobros, lee el cobro mediante su identificador. Trata estos resultados de forma distinta:
  • Error de validación o autorización: corrige la solicitud o el token. No repitas una entrada sin cambios.
  • Respuesta de repetición: conserva el resultado original. No crees una segunda operación de negocio.
  • Conflicto: lee el recurso y elige la siguiente transición legal.
  • Error temporal de dependencia: conserva el valor de idempotencia antes de reintentar. Una ruta que documenta una dependencia de fallo seguro seguirá rechazando la escritura hasta que esa dependencia se restaure.

Mantén claros los límites

Tu cliente es dueño de las llamadas y lecturas de la API pública. El adaptador de conectividad es dueño de los resultados del proveedor. El plugin es dueño del procesamiento de callbacks y de la contabilización en Midaz. Esta separación evita que un cliente fabrique estados de liquidación o evite las comprobaciones de cuenta y proveedor. Continúa con Flujos de SPI para la secuencia de pagos, Flujos de DICT para claves y MED 2.0, o Flujos de COB para BR Codes y cobros.