@lucianpacurar/iso20022.js 0.2.7 → 0.2.9

package/dist/index.d.ts

@@ -622,7 +622,7 @@ declare abstract class PaymentInitiation {
     static getBuilder(): XMLBuilder;
 }
 
-type AtLeastOne$4<T> = [T, ...T[]];
+type AtLeastOne$5<T> = [T, ...T[]];
 /**
  * Configuration for SWIFT Credit Payment Initiation.
  *
@@ -635,7 +635,7 @@ interface SWIFTCreditPaymentInitiationConfig$1 {
     /** The party initiating the payment. */
     initiatingParty: Party;
     /** An array of payment instructions. */
-    paymentInstructions: AtLeastOne$4<SWIFTCreditPaymentInstruction>;
+    paymentInstructions: AtLeastOne$5<SWIFTCreditPaymentInstruction>;
     /** Optional unique identifier for the message. If not provided, a UUID will be generated. */
     messageId?: string;
     /** Optional creation date for the message. If not provided, current date will be used. */
@@ -692,7 +692,7 @@ declare class SWIFTCreditPaymentInitiation extends PaymentInitiation {
     serialize(): string;
 }
 
-type AtLeastOne$3<T> = [T, ...T[]];
+type AtLeastOne$4<T> = [T, ...T[]];
 /**
  * Configuration for SEPA Credit Payment Initiation.
  *
@@ -706,7 +706,7 @@ interface SEPACreditPaymentInitiationConfig$1 {
     /** The party initiating the SEPA credit transfer. */
     initiatingParty: Party;
     /** An array containing at least one payment instruction for SEPA credit transfer. */
-    paymentInstructions: AtLeastOne$3<SEPACreditPaymentInstruction>;
+    paymentInstructions: AtLeastOne$4<SEPACreditPaymentInstruction>;
     /** Optional unique identifier for the message. If not provided, a UUID will be generated. */
     messageId?: string;
     /** Optional creation date for the message. If not provided, current date will be used. */
@@ -739,7 +739,7 @@ declare class SEPACreditPaymentInitiation extends PaymentInitiation {
     initiatingParty: Party;
     messageId: string;
     creationDate: Date;
-    paymentInstructions: AtLeastOne$3<SEPACreditPaymentInstruction>;
+    paymentInstructions: AtLeastOne$4<SEPACreditPaymentInstruction>;
     paymentInformationId: string;
     categoryPurpose?: ExternalCategoryPurpose;
     private formattedPaymentSum;
@@ -816,6 +816,171 @@ declare class SEPACreditPaymentInitiation extends PaymentInitiation {
     static fromXML(rawXml: string): SEPACreditPaymentInitiation;
 }
 
+type AtLeastOne$3<T> = [T, ...T[]];
+/**
+ * Represents a group of payment instructions for a single debtor (PmtInf block).
+ *
+ * @property {Party} initiatingParty - The party (debtor) for this specific payment information block.
+ * @property {AtLeastOne<SEPACreditPaymentInstruction>} payments - An array containing at least one payment instruction for this debtor.
+ * @property {ExternalCategoryPurpose} [categoryPurpose] - Optional category purpose code for this payment information block.
+ */
+interface SEPAMultiCreditPaymentInstructionGroup {
+    /** The party (debtor) for this specific payment information block. */
+    initiatingParty: Party;
+    /** An array containing at least one payment instruction for this debtor. */
+    payments: AtLeastOne$3<SEPACreditPaymentInstruction>;
+    /** Optional category purpose code for this payment information block. */
+    categoryPurpose?: ExternalCategoryPurpose;
+}
+/**
+ * Configuration for SEPA Multi Credit Payment Initiation.
+ *
+ * @property {Party} initiatingParty - The top-level party initiating the message (used in GrpHdr).
+ * @property {AtLeastOne<SEPAMultiCreditPaymentInstructionGroup>} paymentInstructions - An array containing at least one payment instruction group.
+ * @property {string} [messageId] - Optional unique identifier for the message. If not provided, a UUID will be generated.
+ * @property {Date} [creationDate] - Optional creation date for the message. If not provided, current date will be used.
+ */
+interface SEPAMultiCreditPaymentInitiationConfig$1 {
+    /** The top-level party initiating the message (used in GrpHdr). */
+    initiatingParty: Party;
+    /** An array containing at least one payment instruction group. */
+    paymentInstructions: AtLeastOne$3<SEPAMultiCreditPaymentInstructionGroup>;
+    /** Optional unique identifier for the message. If not provided, a UUID will be generated. */
+    messageId?: string;
+    /** Optional creation date for the message. If not provided, current date will be used. */
+    creationDate?: Date;
+}
+/**
+ * Represents a SEPA Multi Credit Payment Initiation.
+ * This class handles the creation and serialization of SEPA credit transfer messages
+ * with multiple payment information blocks (multiple debtors) according to the ISO20022 standard.
+ * @class
+ * @extends PaymentInitiation
+ * @param {SEPAMultiCreditPaymentInitiationConfig} config - The configuration for the SEPA Multi Credit Payment Initiation message.
+ * @example
+ * ```typescript
+ * // Creating a SEPA multi-payment message
+ * const payment = new SEPAMultiCreditPaymentInitiation({
+ *   initiatingParty: { name: 'Company Ltd', id: '12345' },
+ *   paymentInstructions: [
+ *     {
+ *       initiatingParty: debtor1,
+ *       payments: [payment1, payment2]
+ *     },
+ *     {
+ *       initiatingParty: debtor2,
+ *       payments: [payment3]
+ *     }
+ *   ]
+ * });
+ * ```
+ */
+declare class SEPAMultiCreditPaymentInitiation extends PaymentInitiation {
+    initiatingParty: Party;
+    messageId: string;
+    creationDate: Date;
+    paymentInstructions: AtLeastOne$3<SEPAMultiCreditPaymentInstructionGroup>;
+    paymentInformationIdBase: string;
+    private formattedPaymentSum;
+    private totalTransactionCount;
+    /**
+     * Creates an instance of SEPAMultiCreditPaymentInitiation.
+     * @param {SEPAMultiCreditPaymentInitiationConfig} config - The configuration object for the SEPA multi credit transfer.
+     */
+    constructor(config: SEPAMultiCreditPaymentInitiationConfig$1);
+    /**
+     * Counts the total number of transactions across all payment instruction groups.
+     * @private
+     * @returns {number} The total count of all transactions.
+     */
+    private countAllTransactions;
+    /**
+     * Calculates the sum of all payment instructions across all groups.
+     * @private
+     * @returns {string} The total sum formatted as a string with 2 decimal places.
+     */
+    private sumAllPayments;
+    /**
+     * Calculates the sum of payment instructions for a single group.
+     * @private
+     * @param {AtLeastOne<SEPACreditPaymentInstruction>} payments - Array of payment instructions.
+     * @returns {string} The total sum formatted as a string with 2 decimal places.
+     * @throws {Error} If payment instructions have different currencies.
+     */
+    private sumPaymentInstructions;
+    /**
+     * Validates the payment initiation data according to SEPA requirements.
+     * @private
+     * @throws {Error} If messageId exceeds 35 characters.
+     * @throws {Error} If any group's payment instructions have different currencies.
+     */
+    private validate;
+    /**
+     * Validates that all payment instructions in a group have the same currency.
+     * @private
+     * @param {AtLeastOne<SEPACreditPaymentInstruction>} payments - Array of payment instructions.
+     * @throws {Error} If payment instructions have different currencies.
+     */
+    private validateGroupInstructionsHaveSameCurrency;
+    /**
+     * Generates payment information for a single SEPA credit transfer instruction.
+     * @param {SEPACreditPaymentInstruction} instruction - The payment instruction.
+     * @returns {Object} The payment information object formatted according to SEPA specifications.
+     */
+    creditTransfer(instruction: SEPACreditPaymentInstruction): {
+        Cdtr: any;
+        CdtrAcct: {
+            Id: {
+                IBAN: string;
+            };
+            Ccy: "EUR";
+        };
+        RmtInf: {
+            Ustrd: string;
+        } | undefined;
+        CdtrAgt?: {
+            FinInstnId: {
+                BIC: string;
+                ClrSysMmbId?: undefined;
+            };
+        } | {
+            FinInstnId: {
+                ClrSysMmbId: {
+                    ClrSysId: {
+                        Cd: string;
+                    };
+                    MmbId: string;
+                };
+                BIC?: undefined;
+            };
+        } | undefined;
+        PmtId: {
+            InstrId: string;
+            EndToEndId: string;
+        };
+        Amt: {
+            InstdAmt: {
+                '#': string;
+                '@Ccy': "EUR";
+            };
+        };
+    };
+    /**
+     * Serializes the SEPA multi credit transfer initiation to an XML string.
+     * @returns {string} The XML representation of the SEPA multi credit transfer initiation.
+     */
+    serialize(): string;
+    /**
+     * Parses an XML string and creates a SEPAMultiCreditPaymentInitiation instance.
+     * Supports multiple PmtInf blocks in the XML document.
+     * @param {string} rawXml - The XML string to parse.
+     * @returns {SEPAMultiCreditPaymentInitiation} A new instance created from the XML data.
+     * @throws {InvalidXmlError} If the XML format is invalid.
+     * @throws {InvalidXmlNamespaceError} If the namespace is not pain.001.001.03.
+     */
+    static fromXML(rawXml: string): SEPAMultiCreditPaymentInitiation;
+}
+
 type AtLeastOne$2<T> = [T, ...T[]];
 /**
  * Configuration for RTP Credit Payment Initiation.
@@ -1394,6 +1559,53 @@ interface SEPACreditPaymentInitiationConfig {
      */
     creationDate?: Date;
 }
+/**
+ * Configuration interface for SEPA Multi Credit Payment Initiation.
+ * @interface SEPAMultiCreditPaymentInitiationConfig
+ * @example
+ * const config: SEPAMultiCreditPaymentInitiationConfig = {
+ *     paymentInstructions: [
+ *       {
+ *         initiatingParty: debtor1,
+ *         payments: [
+ *           {
+ *             type: 'sepa',
+ *             direction: 'credit',
+ *             amount: 1000, // €10.00 Euros
+ *             currency: 'EUR',
+ *             creditor: {
+ *               name: 'Hans Schneider',
+ *               account: {
+ *                 iban: 'DE1234567890123456',
+ *               },
+ *             },
+ *             remittanceInformation: 'Invoice payment #123',
+ *           },
+ *         ],
+ *         categoryPurpose: 'SALA', // Optional
+ *       },
+ *     ],
+ *     messageId: 'MSGID123', // Optional
+ *     creationDate: new Date(), // Optional
+ * };
+ */
+interface SEPAMultiCreditPaymentInitiationConfig {
+    /**
+     * An array of payment instruction groups, each with its own debtor.
+     * @type {AtLeastOne<SEPAMultiCreditPaymentInstructionGroup>}
+     */
+    paymentInstructions: AtLeastOne<SEPAMultiCreditPaymentInstructionGroup>;
+    /**
+     * Optional unique identifier for the message. If not provided, a UUID will be generated.
+     * @type {string}
+     */
+    messageId?: string;
+    /**
+     * Optional creation date for the message. If not provided, current date will be used.
+     * @type {Date}
+     */
+    creationDate?: Date;
+}
 /**
  * Configuration interface for RTP Credit Payment Initiation.
  * @interface RTPCreditPaymentInitiationConfig
@@ -1575,6 +1787,38 @@ declare class ISO20022 {
      * @returns {SEPACreditPaymentInitiation} A new SEPA Credit Payment Initiation object.
      */
     createSEPACreditPaymentInitiation(config: SEPACreditPaymentInitiationConfig): SEPACreditPaymentInitiation;
+    /**
+     * Creates a SEPA Multi Credit Payment Initiation message with multiple payment information blocks.
+     * @param {SEPAMultiCreditPaymentInitiationConfig} config - Configuration containing payment instruction groups and optional parameters.
+     * @example
+     * const payment = iso20022.createSEPAMultiCreditPaymentInitiation({
+     *   paymentInstructions: [
+     *     {
+     *       initiatingParty: debtor1,
+     *       payments: [
+     *         {
+     *           type: 'sepa',
+     *           direction: 'credit',
+     *           amount: 1000, // €10.00 Euros
+     *           currency: 'EUR',
+     *           creditor: {
+     *             name: 'Hans Schneider',
+     *             account: {
+     *               iban: 'DE1234567890123456',
+     *             },
+     *           },
+     *           remittanceInformation: 'Invoice payment #123',
+     *         },
+     *       ],
+     *       categoryPurpose: 'SALA', // Optional
+     *     },
+     *   ],
+     *   messageId: 'SEPA-MULTI-MSG-001', // Optional
+     *   creationDate: new Date('2025-03-01'), // Optional
+     * });
+     * @returns {SEPAMultiCreditPaymentInitiation} A new SEPA Multi Credit Payment Initiation object.
+     */
+    createSEPAMultiCreditPaymentInitiation(config: SEPAMultiCreditPaymentInitiationConfig): SEPAMultiCreditPaymentInitiation;
     /**
      * Creates a RTP Credit Payment Initiation message.
      * @param {RTPCreditPaymentInitiationConfig} config - Configuration containing payment instructions and optional parameters.
@@ -1893,4 +2137,4 @@ declare class InvalidXmlNamespaceError extends Iso20022JsError {
     constructor(message: string);
 }
 
-export { type ABAAgent, ACHCreditPaymentInitiation, type ACHCreditPaymentInitiationConfig$1 as ACHCreditPaymentInitiationConfig, type ACHCreditPaymentInstruction, type ACHLocalInstrument, ACHLocalInstrumentCode, ACHLocalInstrumentCodeDescriptionMap, type Account, type Agent, type BICAgent, type Balance, type BalanceType, BalanceTypeCode, BalanceTypeCodeDescriptionMap, type BaseAccount, type BaseStatusInformation as BaseStatus, CashManagementEndOfDayReport, type Entry, type GroupStatusInformation as GroupStatus, type IBANAccount, ISO20022, InvalidXmlError, InvalidXmlNamespaceError, Iso20022JsError, type OriginalGroupInformation, type Party, type PaymentStatusInformation as PaymentStatus, PaymentStatusCode, PaymentStatusReport, RTPCreditPaymentInitiation, type RTPCreditPaymentInitiationConfig$1 as RTPCreditPaymentInitiationConfig, type RTPCreditPaymentInstruction, SEPACreditPaymentInitiation, type SEPACreditPaymentInitiationConfig$1 as SEPACreditPaymentInitiationConfig, type SEPACreditPaymentInstruction, SWIFTCreditPaymentInitiation, type SWIFTCreditPaymentInitiationConfig$1 as SWIFTCreditPaymentInitiationConfig, type SWIFTCreditPaymentInstruction, type Statement, type PaymentStatus as Status, type StatusInformation, type StatusType, type StructuredAddress, type Transaction, type TransactionStatusInformation as TransactionStatus };
+export { type ABAAgent, ACHCreditPaymentInitiation, type ACHCreditPaymentInitiationConfig$1 as ACHCreditPaymentInitiationConfig, type ACHCreditPaymentInstruction, type ACHLocalInstrument, ACHLocalInstrumentCode, ACHLocalInstrumentCodeDescriptionMap, type Account, type Agent, type BICAgent, type Balance, type BalanceType, BalanceTypeCode, BalanceTypeCodeDescriptionMap, type BaseAccount, type BaseStatusInformation as BaseStatus, CashManagementEndOfDayReport, type Entry, type GroupStatusInformation as GroupStatus, type IBANAccount, ISO20022, InvalidXmlError, InvalidXmlNamespaceError, Iso20022JsError, type OriginalGroupInformation, type Party, type PaymentStatusInformation as PaymentStatus, PaymentStatusCode, PaymentStatusReport, RTPCreditPaymentInitiation, type RTPCreditPaymentInitiationConfig$1 as RTPCreditPaymentInitiationConfig, type RTPCreditPaymentInstruction, SEPACreditPaymentInitiation, type SEPACreditPaymentInitiationConfig$1 as SEPACreditPaymentInitiationConfig, type SEPACreditPaymentInstruction, SEPAMultiCreditPaymentInitiation, type SEPAMultiCreditPaymentInitiationConfig$1 as SEPAMultiCreditPaymentInitiationConfig, type SEPAMultiCreditPaymentInstructionGroup, SWIFTCreditPaymentInitiation, type SWIFTCreditPaymentInitiationConfig$1 as SWIFTCreditPaymentInitiationConfig, type SWIFTCreditPaymentInstruction, type Statement, type PaymentStatus as Status, type StatusInformation, type StatusType, type StructuredAddress, type Transaction, type TransactionStatusInformation as TransactionStatus };