Saltar al contenido principal

APIs de Lerian


Esta sección responde preguntas frecuentes sobre las APIs de Lerian, cubriendo comportamiento general, configuración y mejores prácticas en todos los servicios.
Sí. Por defecto, el número máximo de registros por página es 100. Este límite garantiza un rendimiento consistente y ayuda a gestionar el volumen de datos transferidos en cada solicitud. Sin embargo, puedes aumentar este valor configurando la variable de entorno MAX_PAGINATION_LIMIT en tu configuración de despliegue. Una vez actualizada y reiniciada la aplicación, la API aceptará tamaños de página más grandes.Importante: Aumentar el tamaño de página puede afectar los tiempos de respuesta, especialmente en entornos que manejan grandes conjuntos de datos. Siempre prueba exhaustivamente en staging antes de aplicar cambios en producción.

Midaz


Aquí encontrarás respuestas a preguntas comunes sobre Organizaciones, Ledgers, Cuentas, Transacciones y más en Midaz.

Organizaciones

No, cada Organización opera de forma independiente y no se comunica con otras.
No, cada licencia está vinculada a una Organización específica. Si necesitas soporte para múltiples Organizaciones, debes adquirir licencias separadas para cada una. La misma regla aplica para los Plugins.
Sí, una Organización puede tener más de un Plugin asociado.
Sí, una Organización puede gestionar múltiples Ledgers.
Aunque puedes crear una Organización Padre y una Organización Hija, cada Organización mantiene su propio Ledger, operando independientemente. Dado que las transacciones no pueden mover valor directamente entre Ledgers, necesitas orquestar la transferencia con los siguientes pasos:
1

Inicia una transacción en el Ledger de origen, transfiriendo el monto de la cuenta original (source) a la cuenta externa del activo (distribute). Esto elimina el valor del Ledger original.
2

Crea una segunda transacción en el Ledger de destino, donde el source es ahora la cuenta externa del activo, y el monto se asigna a la cuenta receptora (distribute).
Este enfoque garantiza transferencias de valor fluidas y controladas entre Ledgers de diferentes organizaciones.

Ledgers

No, los Ledgers no se comunican directamente. Las transferencias entre Ledgers requieren orquestación.
Debes orquestar el proceso y transferir el monto a una Cuenta Externa. Típicamente, esto involucra dos pasos:
1

Ledger A -> Cuenta Externa.
2

Cuenta Externa -> Ledger B.
No, un único Ledger puede soportar múltiples Plugins. Por ejemplo, un Ledger puede manejar tanto Plugins de Exchange como de Pix simultáneamente.

Activos

No, cada Activo está vinculado a una única Cuenta. Sin embargo, cada Activo también estará vinculado a una Cuenta Externa que se crea automáticamente cuando se crea el Activo.
Midaz está construido para flexibilidad, soportando una amplia gama de Activos:
  • currency: Monedas fiduciarias tradicionales como BRL, USD y EUR.
  • crypto: Activos digitales como BTC, ETH y otras criptomonedas.
  • commodities: Bienes tangibles como oro, soja y petróleo.
  • others: Activos personalizados, incluyendo puntos de lealtad y valores tokenizados.

Portafolios

Un Portafolio agrupa cuentas que pertenecen a la misma entidad (CPF/CNPJ). Por ejemplo, si un único CPF tiene dos valores diferentes de segment_id, también tendrá dos valores correspondientes de account_id. Para simplificar la recuperación, se crea un Portafolio para ese CPF, vinculando ambas cuentas bajo una única estructura. Esto garantiza un acceso y gestión más fáciles de cuentas relacionadas.

Cuentas

No, cada Cuenta está asociada con un único Activo, y esta asociación no puede cambiarse.
Una Cuenta Externa se usa para recibir fondos desde fuera del Ledger, efectivamente trayendo dinero al sistema.
Midaz configura automáticamente una Cuenta Externa cuando creas un Activo, garantizando respaldo continuo para todas las transacciones que fluyen dentro y fuera del Ledger.
No. Cada cuenta (account_id) puede estar vinculada solo a un Segmento (segment_id).
No. Puedes crear tantas Cuentas como necesite tu configuración. Sin límites, sin restricciones—solo la flexibilidad para escalar a tu manera.
Para entender el proceso de recarga de saldo, consideremos los siguientes puntos:
  1. En el Ledger de Midaz, cuando se crea un Activo (por ejemplo, BRL), también se genera una Cuenta Externa asociada con ese activo.
  2. Esta Cuenta Externa actúa como puerta de enlace entre el ecosistema de Lerian y el mundo externo. En otras palabras, sirve como espejo de los saldos mantenidos por la institución en su cuenta PI, cuenta de liquidación, cuenta de reserva, o incluso una cuenta bancaria tradicional o de pago que mantiene los fondos reales.
  3. Para depositar fondos en una cuenta de usuario con un Activo específico proveniente de fuera del Ledger de Midaz, el proceso es el siguiente:
    • Inicia una transacción donde la fuente es la Cuenta Externa y el destino es la(s) cuenta(s) objetivo.
    • Como resultado, la Cuenta Externa se debitará por el monto transferido (volviéndose negativa), mientras que la(s) cuenta(s) destino se acreditarán en consecuencia, según los valores proporcionados en la carga útil de la transacción.

Transacciones

Una Transacción debe tener al menos dos Operaciones. Por ejemplo, transferir R$ 100 de la Cuenta A a la Cuenta B consiste en:
  • Operación 1: Debitar R$ 100 de la Cuenta A.
  • Operación 2: Acreditar R$ 100 a la Cuenta B.
Lerian proporciona a los clientes múltiples opciones para acceder a recibos de transacciones:
  1. Vía APIs – Recupera datos de transacciones a través de nuestras APIs, permitiéndote generar un recibo visual en el formato de tu elección.
  2. Usando el Reporter – Extrae datos de transacciones y crea recibos visuales personalizados.
  3. A través de Midaz Console – Accede a información de transacciones directamente desde Midaz Console.

Entidades

Actualmente, la Entidad (entity_id) está abierta para IDs externos, sin validación impuesta por Midaz. Esto significa que puedes usar los IDs que ya existen en tu base de datos, integrándolos sin problemas en tu sistema.

Idempotencia

Midaz trata la solicitud como nueva cada vez. Esto significa que los reintentos pueden resultar en operaciones duplicadas.
No. Las claves deben estar limitadas a una única operación y endpoint.
Solo se usa el TTL de la primera solicitud. Cambiarlo posteriormente no tiene efecto.
Sí. Midaz reproduce la respuesta completa, incluyendo encabezados y cuerpo, para solicitudes completadas.
La ventana predeterminada es 300 segundos (5 minutos), pero puedes personalizarla hasta tu límite permitido por endpoint.

Contabilidad en Midaz

R: Midaz te permite reflejar el Plan de Cuentas oficial de tu organización directamente en la plataforma configurando dos características principales:
  • Tipos de Cuenta – Crea las categorías lógicas de tu plan (por ejemplo, Activos, Pasivos, Ingresos, Gastos) y asígnalas a cuentas en tu Ledger. Cuando la función de Tipos de Cuenta está habilitada, el campo tipo en la API de Cuentas se vuelve obligatorio y debe coincidir con uno de los valores que has registrado.
  • Enrutamiento de Transacciones – Usa Rutas de Operación para validar cada “pierna” de una transacción (por ejemplo, el débito debe provenir de un tipo de cuenta user_wallet) y Rutas de Transacción para definir patrones completos de transacción que se alineen con tu lógica contable.
Al combinar Tipos de Cuenta y Enrutamiento de Transacciones, puedes hacer cumplir tus reglas contables a nivel de Ledger — garantizando que cada transacción sea validada y categorizada según tu Plan de Cuentas, sin codificar reglas en tu lógica de negocio.

Plugins


Los plugins extienden las capacidades de Midaz, habilitando integración fluida y orquestación de procesos. Diseñados para eliminar complejidad, proporcionan abstracciones poderosas que te permiten enfocarte en tu modelo de negocio mientras garantizan eficiencia y escalabilidad. Explora las preguntas más comunes sobre cómo funcionan los plugins, su despliegue y las opciones disponibles para mejorar tus operaciones.
Los plugins son tecnologías integradas en el Ledger de Midaz, diseñadas para simplificar la integración y orquestación de procesos. Proporcionan abstracciones que permiten a los clientes enfocarse en su modelo de negocio sin necesidad de construir o gestionar lógica esencial del sistema que cae fuera de su dominio.
No. Los plugins están diseñados para operar exclusivamente con Midaz. Proporcionan abstracciones específicas y orquestan transacciones basándose en la estructura del Ledger, garantizando integración precisa y eficiente.
Una vez contratados, los plugins se proporcionan e instalan dentro de la infraestructura del cliente (modelo on-premise), junto con su instancia de Midaz. Las aplicaciones se conectan según la funcionalidad específica de cada plugin.
Lerian proporciona dos tipos de plugins, categorizados por su origen:
  • Plugins Nativos: Desarrollados e integrados completamente en el Ledger de Midaz por Lerian, estos plugins garantizan soporte completo e integración fluida con la plataforma.
  • Plugins de Marketplace: Creados por socios de Lerian para servir nichos de mercado específicos, estos plugins están disponibles en el marketplace. Lerian facilita su integración en Midaz, pero su oferta y soporte son gestionados directamente por los socios respectivos.
I