@lucianpacurar/iso20022.js 0.2.7

package/dist/src/camt/003/cash-management-get-account.d.ts

@@ -0,0 +1,26 @@
+import { GenericISO20022Message, ISO20022MessageTypeName } from "../../lib/interfaces";
+import { AccountIdentification, MessageHeader } from "../../lib/types";
+export interface CashManagementGetAccountCriterium {
+    accountRegExp?: string;
+    accountEqualTo?: AccountIdentification;
+    currencyEqualTo?: string;
+    balanceAsOfDateEqualTo?: Date;
+}
+export interface CashManagementGetAccountData {
+    header: MessageHeader;
+    newCriteria: {
+        name: string;
+        searchCriteria: CashManagementGetAccountCriterium[];
+    };
+}
+export declare class CashManagementGetAccount implements GenericISO20022Message {
+    private _data;
+    constructor(data: CashManagementGetAccountData);
+    get data(): CashManagementGetAccountData;
+    static supportedMessages(): ISO20022MessageTypeName[];
+    static fromDocumentOject(doc: any): CashManagementGetAccount;
+    static fromXML(xml: string): CashManagementGetAccount;
+    static fromJSON(json: string): CashManagementGetAccount;
+    serialize(): string;
+    toJSON(): any;
+}

package/dist/src/camt/004/cash-management-return-account.d.ts

@@ -0,0 +1,30 @@
+import { BalanceInReport, BusinessError } from "../types";
+import { GenericISO20022Message, ISO20022MessageTypeName } from "../../lib/interfaces";
+import { AccountIdentification, CashAccountType, MessageHeader } from "../../lib/types";
+import { Currency } from "dinero.js";
+export interface AccountReport {
+    currency: Currency;
+    name?: string;
+    type?: CashAccountType | string;
+    balances: BalanceInReport[];
+}
+export interface AccountReportOrError {
+    accountId: AccountIdentification;
+    report?: AccountReport;
+    error?: BusinessError;
+}
+export interface CashManagementReturnAccountData {
+    header: MessageHeader;
+    reports: AccountReportOrError[];
+}
+export declare class CashManagementReturnAccount implements GenericISO20022Message {
+    private _data;
+    constructor(data: CashManagementReturnAccountData);
+    get data(): CashManagementReturnAccountData;
+    static supportedMessages(): ISO20022MessageTypeName[];
+    static fromDocumentOject(doc: any): CashManagementReturnAccount;
+    static fromXML(xml: string): CashManagementReturnAccount;
+    static fromJSON(json: string): CashManagementReturnAccount;
+    serialize(): string;
+    toJSON(): any;
+}

package/dist/src/camt/005/cash-management-get-transaction.d.ts

@@ -0,0 +1,26 @@
+import { GenericISO20022Message, ISO20022MessageTypeName } from "../../lib/interfaces";
+import { MessageHeader } from "../../lib/types";
+export interface CashManagementGetTransactionCriterium {
+    type: string;
+    msgIdsEqualTo?: string[];
+    dateEqualTo?: Date;
+    endToEndIdEqualTo?: string[];
+}
+export interface CashManagementGetTransactionData {
+    header: MessageHeader;
+    newCriteria?: {
+        name?: string;
+        searchCriteria: CashManagementGetTransactionCriterium[];
+    };
+}
+export declare class CashManagementGetTransaction implements GenericISO20022Message {
+    private _data;
+    constructor(data: CashManagementGetTransactionData);
+    get data(): CashManagementGetTransactionData;
+    static supportedMessages(): ISO20022MessageTypeName[];
+    static fromDocumentOject(doc: any): CashManagementGetTransaction;
+    static fromXML(xml: string): CashManagementGetTransaction;
+    static fromJSON(json: string): CashManagementGetTransaction;
+    serialize(): string;
+    toJSON(): any;
+}

package/dist/src/camt/006/cash-management-return-transaction.d.ts

@@ -0,0 +1,43 @@
+import { BusinessError } from "../types";
+import { GenericISO20022Message, ISO20022MessageTypeName } from "../../lib/interfaces";
+import { Agent, MessageHeader, Party } from "../../lib/types";
+import { Currency } from "dinero.js";
+export interface TransactionReport {
+    msgId?: string;
+    reqExecutionDate?: Date;
+    status?: {
+        code: string;
+        reason?: string;
+    };
+    debtor: Party;
+    debtorAgent: Agent;
+    creditor: Party;
+    creditorAgent: Agent;
+}
+export interface PaymentIdentification {
+    currency: Currency;
+    amount: number;
+    endToEndId: string;
+    transactionId?: string;
+    uetr?: string;
+}
+export interface TransactionReportOrError {
+    paymentId: PaymentIdentification;
+    report?: TransactionReport;
+    error?: BusinessError;
+}
+export interface CashManagementReturnTransactionData {
+    header: MessageHeader;
+    reports: TransactionReportOrError[];
+}
+export declare class CashManagementReturnTransaction implements GenericISO20022Message {
+    private _data;
+    constructor(data: CashManagementReturnTransactionData);
+    get data(): CashManagementReturnTransactionData;
+    static supportedMessages(): ISO20022MessageTypeName[];
+    static fromDocumentOject(doc: any): CashManagementReturnTransaction;
+    static fromXML(xml: string): CashManagementReturnTransaction;
+    static fromJSON(json: string): CashManagementReturnTransaction;
+    serialize(): string;
+    toJSON(): any;
+}

package/dist/src/camt/053/cash-management-end-of-day-report.d.ts

@@ -0,0 +1,90 @@
+import { Balance, Entry, Statement, Transaction } from '../types';
+import { Party, StructuredAddress } from '../../lib/types';
+import { GenericISO20022Message, ISO20022MessageTypeName } from '../../lib/interfaces';
+/**
+ * Configuration interface for creating a CashManagementEndOfDayReport instance.
+ */
+interface CashManagementEndOfDayReportConfig {
+    /** Unique identifier for the message */
+    messageId: string;
+    /** Date and time when the report was created */
+    creationDate: Date;
+    /** Recipient (party without bank and institution) receiving the report */
+    recipient?: {
+        id?: string;
+        name?: string;
+        address?: StructuredAddress;
+    };
+    /** Array of bank statements included in the report */
+    statements: Statement[];
+}
+/**
+ * Represents a Cash Management End of Day Report (CAMT.053.x).
+ * This class encapsulates the data and functionality related to processing
+ * and accessing information from a CAMT.053 XML file.
+ */
+export declare class CashManagementEndOfDayReport implements GenericISO20022Message {
+    private _messageId;
+    private _creationDate;
+    private _recipient?;
+    private _statements;
+    constructor(config: CashManagementEndOfDayReportConfig);
+    static supportedMessages(): ISO20022MessageTypeName[];
+    get data(): CashManagementEndOfDayReportConfig;
+    static fromDocumentObject(obj: {
+        Document: any;
+    }): CashManagementEndOfDayReport;
+    /**
+     * Creates a CashManagementEndOfDayReport instance from a raw XML string.
+     *
+     * @param {string} rawXml - The raw XML string containing the CAMT.053 data.
+     * @returns {CashManagementEndOfDayReport} A new instance of CashManagementEndOfDayReport.
+     * @throws {Error} If the XML parsing fails or required data is missing.
+     */
+    static fromXML(rawXml: string): CashManagementEndOfDayReport;
+    /**
+     *
+     * @param json - JSON string representing a CashManagementEndOfDayReport
+     * @returns {CashManagementEndOfDayReport} A new instance of CashManagementEndOfDayReport
+     * @throws {Error} If the JSON parsing fails or required data is missing.
+     */
+    static fromJSON(json: string): CashManagementEndOfDayReport;
+    toJSON(): any;
+    serialize(): string;
+    /**
+     * Retrieves all balances from all statements in the report.
+     * @returns {Balance[]} An array of all balances across all statements.
+     */
+    get balances(): Balance[];
+    /**
+     * Retrieves all transactions from all statements in the report.
+     * @returns {Transaction[]} An array of all transactions across all statements.
+     */
+    get transactions(): Transaction[];
+    /**
+     * Retrieves all entries from all statements in the report.
+     * @returns {Entry[]} An array of all entries across all statements.
+     */
+    get entries(): Entry[];
+    /**
+     * Gets the unique identifier for the message.
+     * @returns {string} The message ID.
+     */
+    get messageId(): string;
+    /**
+     * Gets the party receiving the report.
+     * @returns {Party | undefined} The recipient party information, or undefined if no recipient is set.
+     */
+    get recipient(): Party | undefined;
+    /**
+     * Gets the date and time when the report was created.
+     * @returns {Date} The creation date of the report.
+     */
+    get creationDate(): Date;
+    /**
+     * Gets all statements included in the report.
+     * @returns {Statement[]} An array of all statements in the report.
+     */
+    get statements(): Statement[];
+}
+export {};

package/dist/src/camt/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./003/cash-management-get-account";
+export * from "./004/cash-management-return-account";
+export * from "./005/cash-management-get-transaction";
+export * from "./006/cash-management-return-transaction";
+export * from "./types";

package/dist/src/camt/types.d.ts

@@ -0,0 +1,191 @@
+import { Currency } from 'dinero.js';
+import { Account, Agent, Party } from '../lib/types';
+/**
+ * Represents a bank statement in the CAMT.053 format.
+ */
+export interface Statement {
+    /** Unique identifier for the statement. */
+    id: string;
+    /** Electronic sequence number of the statement. */
+    electronicSequenceNumber?: number;
+    /** Legal sequence number of the statement. */
+    legalSequenceNumber?: number;
+    /** Date and time when the statement was created. */
+    creationDate: Date;
+    /** Start date of the statement period. */
+    fromDate?: Date;
+    /** End date of the statement period. */
+    toDate?: Date;
+    /** Account details for which the statement is generated. */
+    account: Account;
+    /** Financial institution details. */
+    agent: Agent;
+    /** Total number of entries in the statement. */
+    numOfEntries?: number;
+    /** Sum of all entries in the statement. */
+    sumOfEntries?: number;
+    /** Net amount of all entries in the statement. */
+    netAmountOfEntries?: number;
+    /** Number of credit entries in the statement. */
+    numOfCreditEntries?: number;
+    /** Sum of all credit entries in the statement. */
+    sumOfCreditEntries?: number;
+    /** Number of debit entries in the statement. */
+    numOfDebitEntries?: number;
+    /** Sum of all debit entries in the statement. */
+    sumOfDebitEntries?: number;
+    /** Array of balance information. */
+    balances: Balance[];
+    /** Array of transaction entries. */
+    entries: Entry[];
+}
+/**
+ * Represents a balance in the statement, delinated by date and type.
+ */
+export interface Balance {
+    /** Date of the balance. */
+    date: Date;
+    /** Type of the balance. */
+    type: BalanceType;
+    /** Amount of the balance. */
+    amount: number;
+    /** Indicates whether the balance is credit (positive) or debit (negative). */
+    creditDebitIndicator: 'credit' | 'debit';
+    /** Currency of the balance. */
+    currency: Currency;
+}
+/**
+ * Represents a balance in the CAMT.004 report message.
+ * Currency is not in the balance object but in the parent Report object.
+ */
+export interface BalanceInReport {
+    /** Amount of the balance. */
+    amount: number;
+    /** Indicates whether the balance is credit (positive) or debit (negative). */
+    creditDebitIndicator: 'credit' | 'debit';
+    /** Type of the balance. */
+    type?: BalanceType;
+    valueDate?: Date;
+    processingDate?: Date;
+}
+/**
+ * Represents a transaction entry in the statement.
+ */
+export interface Entry {
+    /** Unique reference ID for the entry, if included in the statement. */
+    referenceId?: string;
+    /** Indicates whether the entry is a credit or debit. */
+    creditDebitIndicator: 'credit' | 'debit';
+    /** Indicates if the entry is a reversal. */
+    reversal: boolean;
+    /** Date when the entry was booked. */
+    bookingDate: Date;
+    /** Amount of the entry. */
+    amount: number;
+    /** Currency of the entry. */
+    currency: Currency;
+    /** Proprietary code associated with the entry. */
+    proprietaryCode: string;
+    /** Array of individual transactions within this entry. */
+    transactions: Transaction[];
+    /** Additional entry information */
+    additionalInformation?: string;
+    /** Reference ID assigned by the account servicer. */
+    accountServicerReferenceId?: string;
+    /** Details about the type of transaction */
+    bankTransactionCode: BankTransactionCode;
+}
+/**
+ * Represents an individual transaction within an entry.
+ */
+export interface Transaction {
+    /** Unique message ID for the transaction. */
+    messageId?: string;
+    /** Reference ID assigned by the account servicer. */
+    accountServicerReferenceId?: string;
+    /** ID of the payment information. */
+    paymentInformationId?: string;
+    /** Instruction ID for the transaction. */
+    instructionId?: string;
+    /** Unique transaction ID. */
+    transactionId?: string;
+    /** Instructed amount for the transaction. */
+    instructedAmount?: number;
+    /** Currency of the instructed amount. */
+    instructedCurrency?: Currency;
+    /** Proprietary purpose code for the transaction. */
+    proprietaryPurpose?: string;
+    /** Details of the debtor party. */
+    debtor?: Party;
+    /** Details of the creditor party. */
+    creditor?: Party;
+    /** Additional information about the remittance. */
+    remittanceInformation?: string;
+    /** Reason for return, if applicable. */
+    returnReason?: string;
+    /** Additional information about the return. */
+    returnAdditionalInformation?: string;
+    /** End-to-end ID for the entry. */
+    endToEndId?: string;
+}
+export interface BankTransactionCode {
+    /** Specifies the business area of the underlying transaction. */
+    domainCode?: string;
+    /** Specifies the family within the domain of the underlying transaction.  */
+    domainFamilyCode?: string;
+    /** Specifies the sub-product family within a specific family of the underlying transaction. */
+    domainSubFamilyCode?: string;
+    /** Bank transaction code in a proprietary form, as defined by the issuer. */
+    proprietaryCode?: string;
+    /** Identification of the issuer of the proprietary bank transaction code. */
+    proprietaryCodeIssuer?: string;
+}
+/**
+ * Balance types as defined in ISO 20022.
+ * @see {@link https://www.iso20022.org/sites/default/files/2022-03/externalcodesets_4q2021_v2_1.xlsx}
+ */
+export declare const BalanceTypeCode: {
+    /** Closing balance of amount of money that is at the disposal of the account owner on the date specified. */
+    readonly ClosingAvailable: "CLAV";
+    /** Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. */
+    readonly ClosingBooked: "CLBD";
+    /** Forward available balance of money that is at the disposal of the account owner on the date specified. */
+    readonly ForwardAvailable: "FWAV";
+    /** Balance for informational purposes. */
+    readonly Information: "INFO";
+    /** Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. */
+    readonly InterimAvailable: "ITAV";
+    /** Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. */
+    readonly InterimBooked: "ITBD";
+    /** Opening balance of amount of money that is at the disposal of the account owner on the date specified. */
+    readonly OpeningAvailable: "OPAV";
+    /** Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report. */
+    readonly OpeningBooked: "OPBD";
+    /** Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date. */
+    readonly PreviouslyClosedBooked: "PRCD";
+    /** Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted. */
+    readonly Expected: "XPCD";
+    /** The difference between the excess/(deficit) investable balance and the excess/(deficit) collected balance due to the reserve requirement. This balance is not used if the account's Earnings Credit Rate is net of reserves. This may be used when the earnings allowance rate is not adjusted for reserves. It may be that reserves have been subtracted from the collected balance to determine the investable balance. Therefore, they must be added back to the excess/(deficit) investable balance to determine the collected balance position. The presentation of this calculation is optional. AFP code=00 04 21 */
+    readonly AdditionalBalReserveRequirement: "ABRR";
+};
+/**
+ * Description mapping of BalanceTypeCode values to their names.
+ */
+export declare const BalanceTypeCodeDescriptionMap: {
+    readonly CLAV: "Closing Available";
+    readonly CLBD: "Closing Booked";
+    readonly FWAV: "Forward Available";
+    readonly INFO: "Information";
+    readonly ITAV: "Interim Available";
+    readonly ITBD: "Interim Booked";
+    readonly OPAV: "Opening Available";
+    readonly OPBD: "Opening Booked";
+    readonly PRCD: "Previously Closed Booked";
+    readonly XPCD: "Expected";
+    readonly ABRR: "Additional Balance Reserve Requirement";
+};
+export type BalanceType = (typeof BalanceTypeCode)[keyof typeof BalanceTypeCode];
+export interface BusinessError {
+    code: string;
+    description?: string;
+}

package/dist/src/camt/utils.d.ts

@@ -0,0 +1,12 @@
+import { Balance, BalanceInReport, BusinessError, Entry, Statement } from 'camt/types';
+import { Currency } from 'dinero.js';
+export declare const parseStatement: (stmt: any) => Statement;
+export declare const exportStatement: (stmt: Statement) => any;
+export declare const parseBalance: (balance: any) => Balance;
+export declare const exportBalance: (balance: Balance) => any;
+export declare const parseBalanceReport: (currency: Currency, balance: any) => BalanceInReport;
+export declare const exportBalanceReport: (currency: Currency, balance: BalanceInReport) => any;
+export declare const parseEntry: (entry: any) => Entry;
+export declare const exportEntry: (entry: Entry) => any;
+export declare const parseBusinessError: (bizErr: any) => BusinessError;
+export declare const exportBusinessError: (bizErr: BusinessError) => any;

package/dist/src/errors.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Base error class for all ISO 20022 related errors in the library.
+ * Extends the native Error class with proper stack trace capture.
+ */
+export declare class Iso20022JsError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error thrown when XML parsing or validation fails.
+ * This error indicates that the provided XML is malformed or does not conform to expected structure.
+ */
+export declare class InvalidXmlError extends Iso20022JsError {
+    constructor(message: string);
+}
+/**
+ * Error thrown when XML namespace validation fails.
+ * This error indicates that the XML document contains invalid or missing required ISO 20022 namespaces.
+ */
+export declare class InvalidXmlNamespaceError extends Iso20022JsError {
+    constructor(message: string);
+}
+export declare class InvalidStructureError extends Iso20022JsError {
+    constructor(message: string);
+}

package/dist/src/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @module iso20022.js · The Open Source Bank Transfer library, build for fiatwebservices.com
+ * @author svapnil <iso20022js@woodside.sh>
+ * @copyright 2025 Woodside Labs
+ * @license MIT
+ * @description
+ * This library allows you to create payment messages in ISO20022.
+ *
+ * Either use an iso20022 object, which represents your acccount,
+ * or create directly from the PaymentInitiation class.
+ *
+ * Current Supported Payment Types:
+ * - SWIFTCreditPaymentInstruction
+ * - SEPACreditPaymentInstruction
+ * - RTPCreditPaymentInstruction
+ * @example
+ * ```typescript
+ * import { ISO20022 } from 'iso20022.js';
+ * const checking = new ISO20022({
+ *     initiatingParty: ...
+ * })
+ * const rtp = checking.createRTPCreditPaymentInitiation([{
+ *     type: 'rtp',
+ *     direction: 'credit',
+ *     amount: 100000, // $1000.00
+ *     currency: 'USD',
+ *     creditor: {
+ *       name: 'All-American Dogs Co.',
+ *       account: {
+ *         accountNumber: '123456789012',
+ *       },
+ *       agent: {
+ *         abaRoutingNumber: '37714568112',
+ *       },
+ *     },
+ *     remittanceInformation: '1000 Hot Dogs Feb26',
+ *   },
+ * ]);
+ * // Using fiatwebservices.com
+ * client.paymentTransfers.create(rtp);
+ * ```
+ * @see {@link https://iso20022js.com} for more information.
+ */
+export { default as ISO20022 } from './iso20022';
+export type { Party, Account, Agent, SWIFTCreditPaymentInstruction, SEPACreditPaymentInstruction, RTPCreditPaymentInstruction, ACHCreditPaymentInstruction, StructuredAddress, IBANAccount, BaseAccount, BICAgent, ABAAgent, ACHLocalInstrument, } from './lib/types';
+export { ACHLocalInstrumentCode, ACHLocalInstrumentCodeDescriptionMap } from './lib/types';
+export type { SWIFTCreditPaymentInitiationConfig } from './pain/001/swift-credit-payment-initiation';
+export { SWIFTCreditPaymentInitiation } from './pain/001/swift-credit-payment-initiation';
+export type { SEPACreditPaymentInitiationConfig } from './pain/001/sepa-credit-payment-initiation';
+export { SEPACreditPaymentInitiation } from './pain/001/sepa-credit-payment-initiation';
+export type { RTPCreditPaymentInitiationConfig } from './pain/001/rtp-credit-payment-initiation';
+export { RTPCreditPaymentInitiation } from './pain/001/rtp-credit-payment-initiation';
+export type { ACHCreditPaymentInitiationConfig } from './pain/001/ach-credit-payment-initiation';
+export { ACHCreditPaymentInitiation } from './pain/001/ach-credit-payment-initiation';
+export type { OriginalGroupInformation, StatusType, PaymentStatus as Status, BaseStatusInformation as BaseStatus, GroupStatusInformation as GroupStatus, PaymentStatusInformation as PaymentStatus, TransactionStatusInformation as TransactionStatus, StatusInformation, } from './pain/002/types';
+export { PaymentStatusCode } from './pain/002/types';
+export { PaymentStatusReport } from './pain/002/payment-status-report';
+export type { Statement, Balance, Entry, Transaction, BalanceType, } from './camt/types';
+export { BalanceTypeCode, BalanceTypeCodeDescriptionMap } from './camt/types';
+export { CashManagementEndOfDayReport } from './camt/053/cash-management-end-of-day-report';
+export { Iso20022JsError, InvalidXmlError, InvalidXmlNamespaceError, } from './errors';