Está viendo la documentación de la versión anterior de Midaz (v2.x.x) y sus plugins. Si está trabajando con la versión actual, consulte la versión más reciente de la documentación para evitar incompatibilidades de versión.
Aspectos destacados
- Arquitectura RESTful: Garantiza APIs predecibles, consistentes y fáciles de usar.
- Intercambio de datos JSON: Simplifica las integraciones con compatibilidad de formato universal.
- Versionado explícito: Garantiza la compatibilidad hacia atrás durante las actualizaciones.
¿Está construyendo un plugin o integración para Lerian? El Hub de Socios tiene todo lo que necesita: estándares de desarrollo, reglas de documentación y herramientas para ayudar a que su solución funcione sin problemas en el ecosistema de Lerian.Recomendado para socios, clientes y equipos internos que trabajan en plugins personalizados
Autenticación
Midaz no incluye un sistema integrado de autenticación o autorización. Esto le brinda la flexibilidad de integrarse con su proveedor de identidad existente o pila de seguridad. Si necesita una solución lista para usar, puede agregar Access Manager, un plugin de pago independiente desarrollado por Lerian. Maneja tanto la autenticación como la autorización granular, facilitando el control de quién puede acceder a qué en su ecosistema Midaz. Para más información, contáctenos.
APIs de Midaz
Midaz está estructurado en tres dominios: Incorporación, Portafolio y Transacciones, cada uno con APIs y endpoints adaptados a funcionalidades específicas. Las tablas a continuación proporcionan una descripción general de los endpoints disponibles dentro de cada dominio:
Dominio de Incorporación
API de Organizaciones
| Endpoint | Path |
|---|---|
| Crear una Organización | POST /v1/organizations |
| Listar Organizaciones | GET /v1/organizations |
| Obtener una Organización | GET /v1/organizations/{organization_id} |
| Actualizar una Organización | PATCH /v1/organizations/{organization_id} |
| Eliminar una Organización | DELETE /v1/organizations/{organization_id} |
API de Ledgers
| Endpoint | Path |
|---|---|
| Crear un Ledger | POST /v1/organizations/{organization_id}/ledgers |
| Listar Ledgers | GET /v1/organizations/{organization_id}/ledgers |
| Obtener un Ledger | GET /v1/organizations/{organization_id}/ledgers/{ledger_id} |
| Actualizar un Ledger | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id} |
| Eliminar un Ledger | DELETE /v1/organizations/{organization_id}/ledgers/{ledger_id} |
Dominio de Portafolio
API de Activos
| Endpoint | Path |
|---|---|
| Crear un Activo | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/assets |
| Listar Activos | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/assets |
| Obtener un Activo | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/assets/{asset_id} |
| Actualizar un Activo | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/assets/{asset_id} |
| Eliminar un Activo | DELETE /v1/organizations/{organization_id}/ledgers/{ledger_id}/assets/{asset_id} |
API de Segmentos
| Endpoint | Path |
|---|---|
| Crear un Segmento | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments |
| Listar Segmentos | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments |
| Obtener un Segmento | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} |
| Actualizar un Segmento | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} |
| Eliminar un Segmento | DELETE /v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} |
API de Portafolios
| Endpoint | Path |
|---|---|
| Crear un Portafolio | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios |
| Listar Portafolios | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios |
| Obtener un Portafolio | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} |
| Actualizar un Portafolio | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} |
| Eliminar un Portafolio | DELETE /v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} |
API de Cuentas
| Endpoint | Path |
|---|---|
| Crear una Cuenta | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts |
| Listar Cuentas | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts |
| Obtener una Cuenta | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} |
| Obtener una Cuenta por Alias | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias} |
| Obtener una Cuenta Externa | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{asset_code} |
| Actualizar una Cuenta | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} |
| Eliminar una Cuenta | DELETE /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} |
Dominio de Transacciones
API de Saldos
| Endpoint | Path |
|---|---|
| Listar Saldos | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/balances |
| Obtener un Saldo | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} |
| Obtener Saldos por Cuenta | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances |
| Obtener una Cuenta por Alias | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances |
| Obtener una Cuenta Externa | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{asset_code}/balances |
| Actualizar un Saldo | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} |
| Eliminar un Saldo | DELETE /v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} |
API de Transacciones
| Endpoint | Path |
|---|---|
| Crear una Transacción usando JSON | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json |
| Crear una Transacción usando DSL | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/dsl |
| Crear una Transacción de Entrada | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/inflow |
| Crear una Transacción de Salida | POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/outflow |
| Listar Transacciones | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions |
| Obtener una Transacción | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id} |
| Actualizar una Transacción | PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id} |
API de Operaciones
| Endpoint | Path |
|---|---|
| Listar Operaciones por Cuenta | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations |
| Obtener una Operación por Cuenta | GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations/{operation_id} |
Lista de errores
Consulte la página Lista de Errores de Midaz para verificar qué errores pueden devolver los endpoints de Midaz. Encontrará todos los detalles que necesita para manejarlos.APIs de Access Manager
El objetivo principal del plugin Access Manager es permitir al cliente controlar efectivamente el acceso de usuarios y gestionar aplicaciones (Midaz y plugins).APIs de Autenticación
API de Autenticación
| Endpoint | Path |
|---|---|
| Solicitar un Token de Acceso | POST /v1/login/oauth/access_token |
| Renovar el Token de Acceso | POST /v1/login/oauth/refresh_token |
| Finalizar Sesión de Usuario | POST /v1/logout |
API de Autorización
| Endpoint | Path |
|---|---|
| Validar Permiso de Usuario | POST /v1/authorize |
API de Información de Usuario
| Endpoint | Path |
|---|---|
| Obtener Información de Usuario | GET /v1/userinfo |
| Obtener Permisos de Usuario | GET /v1/permissions |
APIs de Identidad
API de Grupos
| Endpoint | Path |
|---|---|
| Listar Grupos | GET /v1/groups |
| Obtener detalles de Grupo | GET /v1/groups/{id} |
API de Aplicaciones
| Endpoint | Path |
|---|---|
| Crear una Aplicación | POST /v1/applications |
| Listar Aplicaciones | GET /v1/applications |
| Obtener una Aplicación | GET /v1/applications/{id} |
| Eliminar una Aplicación | DELETE /v1/applications/{id} |
API de Usuarios
| Endpoint | Path |
|---|---|
| Crear un Usuario | POST /v1/users |
| Listar Usuarios | GET /v1/users |
| Obtener detalles de Usuario | GET /v1/users/{id} |
| Actualizar un Usuario | PATCH /v1/users/{id} |
| Eliminar un Usuario | DELETE /v1/users/{id} |
| Restablecer Contraseña de Usuario | PATCH /v1/users/{id}/reset-password |
| Actualizar Contraseña de Usuario | PATCH /v1/users/{id}/update-password |
Lista de errores
Consulte la página Lista de Errores de Access Manager para verificar qué errores pueden devolver los endpoints de Access Manager. Encontrará todos los detalles que necesita para manejarlos.APIs de CRM
El plugin CRM (Gestor de Relaciones con Clientes) integra datos almacenando información de registro esencial para el usuario de la cuenta de Midaz (Titular/Propietario de Cuenta), denominado como “Entidad”. Si bien es necesario para la validación en procesos de integración, no forma parte del dominio transaccional del Ledger.API de Titulares
| Endpoint | Path |
|---|---|
| Crear un Titular | POST /v1/holders |
| Listar Titulares | GET /v1/holders |
| Obtener un Titular | GET /v1/holders/{id} |
| Actualizar un Titular | PATCH /v1/holders/{id} |
| Eliminar un Titular | DELETE /v1/holders/{id} |
API de Cuentas Alias
| Endpoint | Path |
|---|---|
| Crear una Cuenta Alias | POST /v1/holders/{holder_id}/aliases |
| Listar Cuentas Alias | GET /v1/aliases |
| Listar Cuentas Alias para un Titular (obsoleto) | GET /v1/holders/{holder_id}/aliases |
| Obtener Cuenta Alias | GET /v1/holders/{holder_id}/aliases/{alias_id} |
| Actualizar una Cuenta Alias | PATCH /v1/holders/{holder_id}/aliases/{alias_id} |
| Eliminar una Cuenta Alias | DELETE /v1/holders/{holder_id}/aliases/{alias_id} |
Lista de errores
Consulte la página Lista de Errores de CRM para verificar qué errores pueden devolver los endpoints de CRM. Encontrará todos los detalles que necesita para manejarlos.APIs de Fee Engine
El plugin Fee Engine gestiona tarifas en diversas operaciones (financieras, logísticas, agrícolas, farmacéuticas, etc.) mientras almacena transacciones en los ledgers de clientes. Su objetivo es la transparencia, automatización y control eficiente de los cobros de tarifas.API de Paquetes
| Endpoint | Path |
|---|---|
| Crear un Paquete | POST /v1/packages |
| Listar Paquetes | GET /v1/packages |
| Obtener un Paquete | GET /v1/packages/{id} |
| Actualizar un Paquete | PATCH /v1/packages/{id} |
| Eliminar un Paquete | DELETE /v1/packages/{id} |
API de Cálculo
| Endpoint | Path |
|---|---|
| Calcular Tarifas para un Paquete | POST /v1/fees |
API de Simulación
| Endpoint | Path |
|---|---|
| Simular comisión por Transacción | POST /v1/estimates |