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, Transactions 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 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 matriz y una Organización filial, cada Organización mantiene su propio Ledger, operando de forma independiente. 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 desde la cuenta original (source) a la external account del asset (distribute). Esto elimina el valor del ledger original.
2
Crea una segunda transacción en el ledger de destino, donde el source ahora es la external account del asset, y el monto se asigna a la cuenta receptora (distribute).
Este enfoque garantiza transferencias de valor fluidas y controladas entre ledgers de diferentes organizations.

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 implica 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 Exchange como Pix Plugins simultáneamente.

Activos

No, cada Activo está vinculado a un único 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 fiat 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 fidelidad 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ácil de las cuentas relacionadas.

Cuentas

No, cada Cuenta está asociado con un único Activo, y esta asociación no se puede cambiar.
Una External Cuenta se utiliza para recibir fondos desde fuera del Ledger, efectivamente trayendo dinero al sistema.
Midaz configura automáticamente una External Cuenta cuando creas un Activo, garantizando un respaldo perfecto para todas las transacciones que entran y salen del Ledger.
No. Cada cuenta (account_id) solo puede estar vinculada 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 (ej. BRL), también se genera una External Cuenta asociada con ese asset.
2
Esta External Cuenta actúa como puerta de enlace entre el ecosistema de Lerian y el mundo exterior. En otras palabras, sirve como espejo de los saldos mantenidos por la institución en su cuenta de 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 que proviene desde fuera del Ledger de Midaz, el proceso es el siguiente:
  • Inicia una transacción donde el source es la External Cuenta y el destino es la(s) cuenta(s) objetivo.
  • Como resultado, la External Cuenta se debitará por el monto transferido (volviéndose negativa), mientras que la(s) cuenta(s) de destino se acreditarán en consecuencia, según los valores proporcionados en el payload de la transacción.

Transactions

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 Smart Template Plugin – Extrae datos de transacciones y crea recibos visuales personalizados.
  3. A través de Console – Accede a la información de transacciones directamente desde Lerian Console.

Plan de Cuentas

Actualmente, el campo Chart-of-Cuenta está completamente abierto, lo que significa que los usuarios son responsables de ingresar correctamente los valores. En el futuro, un Plugin estará disponible para gestionar este proceso de manera más eficiente.

Entities

Actualmente, el Entity (entity_id) está abierto para IDs externos, sin validación aplicada por Midaz. Esto significa que puedes usar los IDs que ya existen en tu base de datos, integrándolos perfectamente en tu sistema.

Plugins

Los Plugins extienden las capacidades del ledger de Midaz, permitiendo una integración fluida y orquestación de procesos. Diseñados para eliminar la complejidad, proporcionan abstracciones potentes 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 de procesos y la orquestación. Proporcionan abstracciones que permiten a los clientes enfocarse en su modelo de negocio sin necesidad de construir o gestionar la lógica esencial del sistema que queda fuera de su dominio.
No. Los Plugins están diseñados para operar exclusivamente con Midaz. Proporcionan abstracciones específicas y orquestan transacciones basadas 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:
  • Native Plugins: Desarrollados e integrados completamente en el ledger de Midaz por Lerian, estos plugins garantizan soporte completo e integración fluida con la plataforma.
  • Marketplace Plugins: Creados por socios de Lerian para servir nichos específicos del mercado, 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.