🔒 Acceso Protegido

Esta documentación requiere autenticación

Skip to content

Cuentas

Módulo de Gestión de Cuentas

Este módulo maneja toda la funcionalidad relacionada con las cuentas principales del sistema OnSpot.

Descripción General

El módulo de cuentas es responsable de gestionar las cuentas principales de los usuarios, incluyendo la creación, actualización, consulta y administración de información de cuentas.

Funcionalidades Principales

Gestión de Cuentas

  • Crear cuentas: Registro de nuevas cuentas en el sistema
  • Consultar cuentas: Obtener información de cuentas individuales o listas
  • Actualizar cuentas: Modificar información de cuentas existentes
  • Desactivar cuentas: Suspender o desactivar cuentas

Tipos de Cuenta

  • Cuenta Principal: Cuenta primaria del usuario
  • Cuenta Empresarial: Para organizaciones y empresas
  • Cuenta Personal: Para usuarios individuales

Estructura de Datos

Entidad Cuenta

typescript
@Entity('accounts')
export class Account {
  @PrimaryGeneratedColumn('uuid')
  id: string;

  @Column()
  accountName: string;

  @Column()
  accountType: AccountType;

  @Column()
  ownerId: string;

  @Column({ type: 'decimal', precision: 10, scale: 2 })
  balance: number;

  @Column()
  currency: string;

  @Column({ default: true })
  isActive: boolean;

  @CreateDateColumn()
  createdAt: Date;

  @UpdateDateColumn()
  updatedAt: Date;
}

Endpoints Principales

  • GET /accounts - Listar cuentas
  • GET /accounts/:id - Obtener cuenta por ID
  • POST /accounts - Crear nueva cuenta
  • PUT /accounts/:id - Actualizar cuenta
  • DELETE /accounts/:id - Desactivar cuenta
  • GET /accounts/:id/balance - Consultar saldo de cuenta

Validaciones

DTOs de Entrada

  • Validación de nombre de cuenta
  • Validación de tipo de cuenta
  • Validación de propietario
  • Validación de moneda

DTOs de Salida

  • Formateo de saldos
  • Información de propietario
  • Estado de la cuenta
  • Historial de transacciones

Seguridad

  • Control de acceso por propietario
  • Validación de permisos para operaciones
  • Auditoría de cambios en cuentas
  • Protección de datos sensibles

Relaciones

El módulo de cuentas se relaciona con:

  • Users: Propietarios de las cuentas
  • Sub-accounts: Subcuentas asociadas
  • Transactions: Historial de transacciones
  • Withdrawals: Operaciones de retiro
  • Accreditations: Acreditaciones de fondos

Casos de Uso

Creación de Cuenta

  1. Usuario solicita crear cuenta
  2. Sistema valida datos
  3. Se crea la cuenta con saldo inicial
  4. Se notifica al usuario

Consulta de Saldo

  1. Usuario solicita consultar saldo
  2. Sistema verifica permisos
  3. Se retorna información actualizada
  4. Se registra la consulta

Transferencia entre Cuentas

  1. Usuario inicia transferencia
  2. Sistema valida fondos disponibles
  3. Se ejecuta la transferencia
  4. Se actualizan los saldos
  5. Se notifica a ambas partes

Versión: 1.0 | Actualizado: hace 2 meses

Documentación OnspotIntl