@fiado/type-kit 3.463.0 → 3.464.0

package/src/moneyTransfer/dtos/SettlementListResponse.ts

@@ -0,0 +1,7 @@
+import { SettlementResponse } from "./SettlementResponse";
+
+/** Página de liquidaciones (sin `details`). */
+export class SettlementListResponse {
+    items!: SettlementResponse[];
+    nextToken?: string;
+}

package/src/moneyTransfer/dtos/SettlementResponse.ts

@@ -0,0 +1,37 @@
+import { SettlementStatusEnum } from "../enums/SettlementStatusEnum";
+import { TransferChannelEnum } from "../enums/TransferChannelEnum";
+import { TransactionDetailResponse } from "./TransactionDetailResponse";
+
+/**
+ * Liquidación (lote de folios de un producto enviado al riel). Sin decoradores
+ * `class-validator`: el consumidor la lee tal cual viene por la red. Timestamps en epoch ms.
+ */
+export class SettlementResponse {
+    settlementId!: string;
+    tenantId!: string;
+    productId!: string;
+    serviceId!: number;
+    channel!: TransferChannelEnum;
+    currency!: string;
+    beneficiaryName!: string;
+    totalAmount!: number;
+    itemCount!: number;
+    status!: SettlementStatusEnum;
+    scheduledAt?: number;
+    /** Id de la transacción en el riel (ACH) o clave de rastreo (SPEI). */
+    achTransactionId?: string;
+    returnReason?: string;
+    lastError?: string;
+    /** `true` cuando el envío no obtuvo respuesta concluyente del riel (posible duplicado). */
+    uncertain?: boolean;
+    attempts!: number;
+    attemptedAt?: number;
+    sentAt?: number;
+    settledAt?: number;
+    createdBy!: string;
+    sentBy?: string;
+    createdAt!: number;
+    updatedAt!: number;
+    /** Folios incluidos; solo viene en el detalle, no en el listado. */
+    details?: TransactionDetailResponse[];
+}

package/src/moneyTransfer/dtos/SettlementStatusMessage.ts

@@ -0,0 +1,23 @@
+import { IsEnum, IsNotEmpty, IsOptional, IsString, MaxLength } from "class-validator";
+import { SpeiOrderStatusEnum } from "../enums/SpeiOrderStatusEnum";
+
+/**
+ * Mensaje asíncrono con el estado de una orden SPEI (lo emite el conector STP y lo consume
+ * `money-transfer-connector` para cerrar la liquidación). `claveRastreo` es la clave de
+ * rastreo SPEI (máx. 30 chars según STP).
+ */
+export class SettlementStatusMessage {
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(30)
+    claveRastreo!: string;
+
+    @IsEnum(SpeiOrderStatusEnum)
+    status!: SpeiOrderStatusEnum;
+
+    /** Motivo reportado por el riel (devolución / cancelación). */
+    @IsOptional()
+    @IsString()
+    @MaxLength(256)
+    reason?: string;
+}

package/src/moneyTransfer/dtos/TransactionDetailResponse.ts

@@ -0,0 +1,25 @@
+import { SettlementModeEnum } from "../enums/SettlementModeEnum";
+import { TransactionDetailStatusEnum } from "../enums/TransactionDetailStatusEnum";
+import { TransferChannelEnum } from "../enums/TransferChannelEnum";
+
+/**
+ * Folio cobrado al usuario pendiente de (o ya incluido en) una liquidación.
+ * Sin decoradores `class-validator`: el consumidor la lee tal cual viene por la red.
+ */
+export class TransactionDetailResponse {
+    transactionNumber!: string;
+    directoryId!: string;
+    tenantId!: string;
+    serviceId!: number;
+    productId!: string;
+    channel!: TransferChannelEnum;
+    amount!: number;
+    currency!: string;
+    reference!: string;
+    settlementMode!: SettlementModeEnum;
+    status!: TransactionDetailStatusEnum;
+    /** Presente cuando el folio ya fue agrupado en una liquidación. */
+    settlementId?: string;
+    /** Epoch ms. */
+    createdAt!: number;
+}

package/src/moneyTransfer/enums/SettlementModeEnum.ts

@@ -0,0 +1,5 @@
+/** Cuándo se liquida al beneficiario: en el momento del pago o agrupado en un lote programado. */
+export enum SettlementModeEnum {
+    IMMEDIATE = 'IMMEDIATE',
+    BATCH = 'BATCH',
+}

package/src/moneyTransfer/enums/SettlementStatusEnum.ts

@@ -0,0 +1,11 @@
+/** Ciclo de vida de una liquidación (lote de folios enviado al riel). */
+export enum SettlementStatusEnum {
+    CREATED = 'CREATED',
+    SCHEDULED = 'SCHEDULED',
+    SENDING = 'SENDING',
+    SENT = 'SENT',
+    SETTLED = 'SETTLED',
+    RETURNED = 'RETURNED',
+    FAILED = 'FAILED',
+    CANCELLED = 'CANCELLED',
+}

package/src/moneyTransfer/enums/SpeiOrderStatusEnum.ts

@@ -0,0 +1,11 @@
+/**
+ * Estado de una orden SPEI tal como lo reporta STP (LQ liquidada, D devuelta, CN cancelada),
+ * más los estados internos PENDING (sin respuesta aún) y UNKNOWN (código no mapeado).
+ */
+export enum SpeiOrderStatusEnum {
+    LQ = 'LQ',
+    D = 'D',
+    CN = 'CN',
+    PENDING = 'PENDING',
+    UNKNOWN = 'UNKNOWN',
+}

package/src/moneyTransfer/enums/TransactionDetailStatusEnum.ts

@@ -0,0 +1,7 @@
+/** Estado de un folio individual (transacción cobrada al usuario) respecto a su liquidación. */
+export enum TransactionDetailStatusEnum {
+    PENDING_SETTLEMENT = 'PENDING_SETTLEMENT',
+    SETTLED = 'SETTLED',
+    RETURNED = 'RETURNED',
+    FAILED = 'FAILED',
+}

package/src/moneyTransfer/enums/TransferChannelEnum.ts

@@ -0,0 +1,5 @@
+/** Riel por el que se dispersa el dinero al beneficiario del producto. */
+export enum TransferChannelEnum {
+    SPEI = 'SPEI',
+    ACH = 'ACH',
+}

package/src/moneyTransfer/index.ts

@@ -0,0 +1,27 @@
+// moneyTransfer — money-transfer-connector (Centro de Beneficios)
+// Contrato del conector de transferencias de dinero: catálogo de servicios/productos con riel
+// (SPEI/ACH) y modo de liquidación (inmediata/lote), liquidaciones y estado de órdenes SPEI.
+
+//Enums
+export * from './enums/TransferChannelEnum';
+export * from './enums/SettlementModeEnum';
+export * from './enums/SettlementStatusEnum';
+export * from './enums/TransactionDetailStatusEnum';
+export * from './enums/SpeiOrderStatusEnum';
+
+//Mensajes async (SQS FIFO money-transfer-settlement-status, DEC-013)
+export * from './dtos/SettlementStatusMessage';
+//DTOs — requests
+export * from './dtos/BatchScheduleRequest';
+export * from './dtos/MoneyTransferProductRequest';
+export * from './dtos/MoneyTransferServiceCreateRequest';
+export * from './dtos/MoneyTransferServiceUpdateRequest';
+export * from './dtos/CreateSettlementRequest';
+export * from './dtos/SettlementActionRequest';
+export * from './dtos/RescheduleSettlementRequest';
+
+//DTOs — responses
+export * from './dtos/TransactionDetailResponse';
+export * from './dtos/SettlementResponse';
+export * from './dtos/PendingDetailsResponse';
+export * from './dtos/SettlementListResponse';

package/src/productCatalog/enums/ProductTypeEnum.ts

@@ -58,5 +58,10 @@ export enum ProductTypeEnum {
      * Reversa de un reembolso anterior — se devuelve el dinero del reembolso al cliente
      * cuando el dictamen fue incorrecto o se detectó fraude post-reembolso.
      */
-    REFUND_PCF_REVERSE = "REFUND_PCF_REVERSE"
+    REFUND_PCF_REVERSE = "REFUND_PCF_REVERSE",
+    /**
+     * Dispersión SPEI de liquidaciones de beneficios (money-transfer-connector).
+     * Producto del catálogo para la orden STP que sale con `source=BENEFITS_SETTLEMENT`.
+     */
+    MONEY_TRANSFER_SA = "MONEY_TRANSFER_SA"
 }

package/src/provider/enums/Provider.ts

@@ -10,5 +10,6 @@ export enum Provider {
     MULTICENTER_SERVICE_PAYMENT = "MULTICENTER_SERVICE_PAYMENT",
     UNITELLER = "UNITELLER",
     EQUALITY = "EQUALITY",
-    SYNERGYPAY = "SYNERGYPAY"
+    SYNERGYPAY = "SYNERGYPAY",
+    MONEY_TRANSFER = "MONEY_TRANSFER"
 }

package/src/stpSpei/dtos/ConsultStpOrderRequest.ts

@@ -0,0 +1,9 @@
+import { BusinessNameEnum } from '../enums/BusinessNameEnum';
+
+export class ConsultStpOrderRequest {
+    transactionNumber: string;
+    orderType: "E" | "R";
+    operationDate: string;
+    /** DEC-037: empresa con la que se firmó la orden; sin él, fiado-stp-lambda usa FIADOSA */
+    businessName?: BusinessNameEnum;
+}

package/src/stpSpei/dtos/PutStpOrderRequest.ts

@@ -1,20 +1,29 @@
+import { StpOrderSourceEnum } from '../enums/StpOrderSourceEnum';
+
 export class PutStpOrderRequest {
-    processorObject: any | null;
-    directoryId: string;
-    phoneNumber: string;
-    indexName: string;
+    processorObject?: any | null;
+    directoryId?: string;
+    phoneNumber?: string;
+    indexName?: string;
     amount: number;
     transactionNumber: string;
     numericReference: number;
     concept: string | null;
     beneficiaryAccount: string;
     beneficiaryName: string;
-    bankName: string;
+    bankName?: string;
     bankCode: string;
-    originatorAccountNumber: string;
-    originatorCurp: string;
-    originatorName: string;
+    originatorAccountNumber?: string;
+    originatorCurp?: string;
+    originatorName?: string;
     latitude?: number;
     longitude?: number;
     sessionId?: string;
-}
+    /**
+     * Origen de la orden: USER_TRANSFER (default, comportamiento actual)
+     * | BENEFITS_SETTLEMENT (money-transfer-connector, DEC-013)
+     */
+    source?: StpOrderSourceEnum;
+    /** RFC del beneficiario — solo aplica a órdenes BENEFITS_SETTLEMENT. */
+    beneficiaryRfc?: string;
+}

package/src/stpSpei/enums/StpOrderSourceEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Origen de una orden STP (`PutStpOrderRequest.source`).
+ * - USER_TRANSFER: transferencia iniciada por un usuario (default, comportamiento actual).
+ * - BENEFITS_SETTLEMENT: liquidación de beneficios emitida por money-transfer-connector (DEC-013).
+ */
+export enum StpOrderSourceEnum {
+    USER_TRANSFER = "USER_TRANSFER",
+    BENEFITS_SETTLEMENT = "BENEFITS_SETTLEMENT"
+}

package/src/stpSpei/index.ts

@@ -1,4 +1,5 @@
 export * from './dtos/PutStpOrderRequest';
+export * from './dtos/ConsultStpOrderRequest';
 export * from './dtos/SpeiWebhookMessage';
 export * from './dtos/GetBusinessAccountBalanceResponse';
 export * from './dtos/SpeiAcuseCepRequest';
@@ -8,3 +9,4 @@ export * from './enums/ActividadesProductivasEnum';
 export * from './enums/EntidadesFederativasEnum';
 export * from './enums/PaisesEnum';
 export * from './enums/BusinessNameEnum';
+export * from './enums/StpOrderSourceEnum';