Schemas
Modelos de datos utilizados en la API de Información de Cuentas. Cada schema define la estructura JSON de los objetos retornados por los endpoints.
Account
Representa una cuenta bancaria del cliente. Contiene información básica como tipo, número enmascarado, moneda y saldo disponible.
| Propiedad | Tipo | Requerido | Descripción |
|---|---|---|---|
accountId | string (uuid) | Sí | Identificador único de la cuenta Ejemplo: c7b5b8a0-5b9a-4b0e-8c3b-3e6a1b2a3f4d |
accountType | stringAHORROCORRIENTEMONETARIA | Sí | Tipo de cuenta bancaria Ejemplo: AHORRO |
accountNumber | string | Sí | Número de cuenta enmascarado por seguridad Ejemplo: XXXX-XXXX-XX-XXXXXX1234 |
currency | string | Sí | Código de moneda ISO 4217 Ejemplo: GTQ |
balance | number (double) | Sí | Saldo disponible en la cuenta Ejemplo: 12550.75 |
Transaction
Representa una transacción o movimiento en una cuenta. Incluye información del monto, tipo (débito/crédito), fecha y saldo resultante.
| Propiedad | Tipo | Requerido | Descripción |
|---|---|---|---|
transactionId | string (uuid) | Sí | Identificador único de la transacción Ejemplo: f4d3b2a1-c9e8-4f7b-9a6d-5c4b3a2e1d0f |
date | string (date-time) | Sí | Fecha y hora de la transacción en formato ISO 8601 Ejemplo: 2024-05-20T14:30:00Z |
description | string | Sí | Descripción o concepto de la transacción Ejemplo: PAGO DE SERVICIOS EN LINEA |
amount | number (double) | Sí | Monto de la transacción (negativo para débitos) Ejemplo: -250.00 |
currency | string | Sí | Código de moneda ISO 4217 Ejemplo: GTQ |
type | stringDEBITOCREDITO | Sí | Tipo de movimiento Ejemplo: DEBITO |
balanceAfter | number (double) | No | Saldo en la cuenta después de la transacción Ejemplo: 12300.75 |