1. Saldos
| Campo | Descripción | Usado en |
|---|---|---|
| key | Identificador único del saldo dentro del contexto de la cuenta | Midaz |
| available | Monto disponible para transacciones | Midaz |
| onHold | Monto actualmente reservado o retenido | Midaz |
| version | Versión del saldo, actualizada con cada transacción (para concurrencia optimista) | Midaz |
| accountType | Tipo de cuenta que contiene este saldo | Midaz |
| allowSending | Indica si el saldo puede usarse para enviar transacciones | Midaz |
| allowReceiving | Indica si el saldo puede usarse para recibir transacciones | Midaz |
| assetCode | Código de activo o moneda (por ejemplo, BRL, USD) | Midaz |
| alias | Alias de la cuenta para identificación rápida | Midaz |
2. Rutas de transacción
| Campo | Descripción | Usado en |
|---|---|---|
| title | Texto breve que resume el propósito de la ruta (máximo 256 caracteres) | Midaz |
| description | Descripción detallada de la ruta de transacción (máximo 256 caracteres) | Midaz |
| operationRoutes | En las solicitudes, arreglo de IDs de rutas de operación que definen la lógica de origen y destino; en las respuestas, arreglo de objetos OperationRoute | Midaz |
3. Rutas de operación
| Campo | Descripción | Usado en |
|---|---|---|
| operationType | Dirección de la ruta: origen, destino o bidireccional | Midaz |
| code | Código de referencia externo de la ruta de operación | Midaz |
| account | Regla de selección de cuenta para la operación | Midaz |
| ruleType | Método de selección de cuenta: alias o account_type | Midaz |
| validIf | Condición que debe cumplirse para que la regla coincida | Midaz |
4. Índices de metadatos
| Campo | Descripción | Usado en |
|---|---|---|
| metadataKey | Clave de metadatos a indexar (máximo 100 caracteres, debe coincidir con el nombre del campo en las entidades) | Midaz |
| unique | Indica si el índice aplica unicidad (los valores duplicados se rechazan cuando es true) | Midaz |
| sparse | Indica si el índice es disperso (solo indexa las entidades que contienen el campo) | Midaz |
| indexName | Nombre del índice creado | Midaz |
| entityName | Nombre de la colección de entidades a la que se aplica el índice | Midaz |