Midaz te permite crear tantas cuentas como exija tu estructura. Sin límites, sin restricciones; solo la flexibilidad que necesitas.
Estructura de la Cuenta
- Cuenta > Libro Mayor (Ledger): Las Cuentas se crean dentro de un Libro Mayor, que rastrea y consolida todos los saldos y operaciones.
- Cuenta > Cartera (Portfolio): Las Cuentas se pueden agrupar en Carteras para representar grupos de clientes, líneas de productos o unidades de negocio.
- Cuenta > Activo (Asset): Cada Cuenta está vinculada a un único Activo, que define el tipo de valor que posee, como BRL, USD, BTC o puntos de fidelidad.
- Cuenta > Tipo de Cuenta (Account Type): Con la validación de Tipo de Cuenta habilitada, cada Cuenta debe categorizarse por un Tipo de Cuenta que se puede crear de acuerdo con necesidades específicas del usuario o clasificación de negocio.
Características clave
- Cada cuenta está vinculada exactamente a un tipo de activo.
- Las cuentas se identifican de forma única dentro de un ledger (libro mayor).
- Todas las transacciones implican débitos y créditos entre cuentas.
Cuenta Externa (External Account)
Las Cuentas Externas en Midaz representan cuentas fuera de la estructura de tu organización. Se utilizan para rastrear dinero que está entrando o saliendo, generalmente vinculado a usuarios, socios o proveedores financieros fuera de tu libro mayor interno. Pero son más que simples marcadores de posición. Las Cuentas Externas:
- Gestionan saldos temporales durante operaciones que involucran a partes externas.
- Son las únicas cuentas a las que se les permite ir a negativo, lo que indica que los fondos están en tránsito.
- Se crean automáticamente por el Libro Mayor cada vez que se crea un Activo (Asset).
- Siguen un patrón de nomenclatura claro:
@external/<código-activo>
, como@external/BRL
.
Para mantener el Libro Mayor preciso y fiable, las cuentas externas no se pueden eliminar ni modificar.
ID de Cuenta Padre (Parent Account ID)
El ID de Cuenta Padre vincula dos cuentas dentro de Midaz, lo que te da la flexibilidad de definir la relación basándose en tu lógica de negocio. Ya sea que lo uses para representar una estructura tradicional de padre-hijo o algo completamente distinto, la elección es tuya. Midaz proporciona la base; tú decides cómo construir sobre ella.
Alias de Cuenta (Account aliases)
Los alias facilitan la identificación de cuentas al reemplazar IDs complejos con etiquetas legibles y fáciles de usar.
- Por ejemplo: En lugar de hacer referencia a una cuenta como
3172933b-50d2-4b17-96aa-9b378d6a6eac
, simplemente puedes usar@username_1
.
Usar el Alias de Cuenta en Transacciones
Al crear una transacción, utiliza siempre el alias de cuenta en el campoaccount
, no el ID de cuenta.
Asignar un alias al crear una cuenta es opcional. Si lo omites, no hay problema: el sistema utilizará automáticamente el ID de cuenta como alias. De cualquier manera, cada cuenta termina con un alias único.
Así que cuando sea el momento de hacer referencia a una cuenta en una transacción, simplemente usa el alias. Limpio, coherente y listo para usar.
Tipos de Cuenta (Account types)
Los Tipos de Cuenta en Midaz te permiten clasificar sistemáticamente las cuentas de acuerdo con las necesidades de la estructura financiera de tu organización. Estas clasificaciones definen la naturaleza y el propósito de las cuentas dentro del diseño de tu libro mayor, lo que permite un enrutamiento de transacciones adecuado y una validación operativa en diferentes categorías de cuentas. Los Tipos de Cuenta se pueden personalizar a través de la API de Tipos de Cuenta para que coincidan con tus requisitos comerciales y flujos de trabajo financieros específicos, proporcionando la base para el procesamiento de transacciones estructurado mientras se mantiene la integridad de los datos.
Habilitación de la validación de Tipo de Cuenta
En caso de que desees activar la validación de tipo de cuenta para un libro mayor específico, debes configurarlo en el servicio de Onboarding. Esto significa actualizar la variable en el archivo.env
del servicio Midaz Onboarding donde deseas utilizar la validación de tipo.
Tu configuración debería verse así:
Comportamiento del campo type
en la API de Cuentas
Al crear una Cuenta, el comportamiento del campo type
se adapta en función de la activación de la característica de Validación de Tipo de Cuenta:
- Validación de Tipo de Cuenta Deshabilitada (Predeterminada): El campo
type
es opcional y acepta cualquier cadena de formato libre (free-form string). - Validación de Tipo de Cuenta Habilitada: El campo
type
se vuelve obligatorio y debe coincidir con uno de los Tipos de Cuenta registrados previamente a través de la API de Tipos de Cuenta. Si se envía un tipo no válido o no registrado, el sistema devolverá un error de validación.
Si tu organización está habilitando la característica de Validación de Tipo de Cuenta, recomendamos revisar las cuentas existentes. Es posible que debas recrearlas o asignar retroactivamente el Tipo de Cuenta apropiado para alinearlas con tu estructura contable.
Gestión de Tipos de Cuenta
Puedes gestionar tus Tipos de Cuenta exclusivamente a través de la API.- Crear un Tipo de Cuenta — Registra un nuevo Tipo de Cuenta para tu Libro Mayor.
- Listar Tipos de Cuenta — Recupera todos los Tipos de Cuenta configurados en tu Libro Mayor.
- Recuperar un Tipo de Cuenta — Obtén información detallada sobre un Tipo de Cuenta específico.
- Actualizar un Tipo de Cuenta — Modifica la definición de un Tipo de Cuenta existente.
- Eliminar un Tipo de Cuenta — Elimina un Tipo de Cuenta que ya no está en uso.
Gestión de Cuentas
Puedes gestionar tus cuentas a través de la API o mediante Midaz Console.
Vía API
- Crear una Cuenta — Abre una nueva Cuenta vinculada a un Activo.
- Listar Cuentas — Consulta todas las Cuentas en tu espacio de trabajo.
- Recuperar una Cuenta — Obtén detalles de una Cuenta específica.
- Recuperar una Cuenta por Alias — Obtén detalles de una Cuenta específica por su alias.
- Recuperar una Cuenta Externa — Obtén detalles de una Cuenta Externa específica por su código de activo.
- Actualizar una Cuenta — Edita los metadatos o la configuración de una Cuenta existente.
- Eliminar una Cuenta — Elimina una Cuenta específica.
No puedes desactivar una cuenta con un saldo restante. Primero, transfiere el monto a otra cuenta antes de desactivarla.