routex-client 0.4.8 → 0.5.0

package/README.md

@@ -4,6 +4,22 @@ A client for [YAXI](https://yaxi.tech/)'s Open Banking services.
 
 ## Changelog
 
+### [0.5.0] - 2026-02-20
+
+#### Added
+
+- `RoutexClient.systemVersion`
+- `RoutexClient.transfer`, `RoutexClient.respondTransfer`, `RoutexClient.confirmTransfer`
+
+#### Removed
+
+- `RoutexClient.measurement`
+
+#### Fixed
+
+- `AccountFilter.any` with more than two elements
+- `PaymentFailedException.userMessage` was always `undefined`
+
 ### [0.4.8] - 2026-02-04
 
 #### Added

package/client.d.ts

@@ -138,10 +138,78 @@ export interface CollectPaymentOptions extends ServiceOptions {
         currency?: string;
     };
 }
+export interface TransferOptions extends ServiceOptions {
+    product: PaymentProduct;
+    debtorAccount?: AccountReference;
+    debtorName?: string;
+    requestedExecutionDate?: Date;
+    details: {
+        endToEndIdentification?: string;
+        amount: {
+            /**
+             * Decimal amount, e.g. "123.45".
+             */
+            amount: string | number;
+            /**
+             * ISO 4217 Alpha 3 currency code.
+             */
+            currency: string;
+        };
+        creditorAccount: {
+            iban: string;
+        };
+        creditorAgentBic?: string;
+        creditorName: string;
+        creditorAddress?: {
+            townName: string;
+            /**
+             * ISO 3166-1 ALPHA-2 country code.
+             */
+            country: string;
+        };
+        remittance?: string;
+        chargeBearer?: ChargeBearer;
+    }[];
+}
 interface AccountReference {
     iban: string;
     currency?: string;
 }
+export declare enum PaymentProduct {
+    /**
+     * SEPA Credit Transfer (SCT) in EUR
+     */
+    SepaCreditTransfer = "SEPA_CREDIT_TRANSFER",
+    /**
+     * SEPA Instant Credit Transfer (SCT Inst) in EUR
+     */
+    SepaInstantCreditTransfer = "SEPA_INSTANT_CREDIT_TRANSFER",
+    /**
+     * Default SEPA Credit Transfer in EUR
+     *
+     * Tries SCT Inst with a fallback to SCT if this is supported.
+     * Otherwise, SCT is used.
+     */
+    DefaultSepaCreditTransfer = "DEFAULT_SEPA_CREDIT_TRANSFER",
+    /**
+     * International credit transfer outside of SEPA (typically SWIFT)
+     */
+    CrossBorderCreditTransfer = "CROSS_BORDER_CREDIT_TRANSFER",
+    /**
+     * Domestic credit transfer in the domestic, non-EUR currency
+     */
+    DomesticCreditTransfer = "DOMESTIC_CREDIT_TRANSFER",
+    /**
+     * Instant domestic credit transfer in the domestic, non-EUR currency
+     */
+    DomesticInstantCreditTransfer = "DOMESTIC_INSTANT_CREDIT_TRANSFER"
+}
+export declare enum ChargeBearer {
+    BorneByDebtor = "DEBT",
+    BorneByCreditor = "CRED",
+    Shared = "SHAR",
+    FollowingServiceLevel = "SLEV"
+}
 export interface Credentials {
     connectionId: string;
     userId?: string;
@@ -499,6 +567,10 @@ export declare class RoutexClient {
     constructor(options?: RoutexClientOptions);
     private _unsealBody;
     private _request;
+    /**
+     * System version for the currently established session
+     */
+    systemVersion(): string | undefined;
     /**
      * Search for service connections (banks and other providers)
      *
@@ -594,6 +666,18 @@ export declare class RoutexClient {
      * Confirm {@link Dialog} or {@link Redirect} returned initiating the payment
      */
     confirmCollectPayment(options: ConfirmationOptions): Promise<OBResponse>;
+    /**
+     * [Transfer service]{@link https://docs.yaxi.tech/transfer.html}
+     */
+    transfer({ credentials, session, recurringConsents, ticket, product, debtorAccount, debtorName, requestedExecutionDate, details, }: TransferOptions): Promise<OBResponse>;
+    /**
+     * Respond to {@link Dialog} returned while initiating the transfer
+     */
+    respondTransfer(options: ResponseOptions): Promise<OBResponse>;
+    /**
+     * Confirm {@link Dialog} or {@link Redirect} returned initiating the transfer
+     */
+    confirmTransfer(options: ConfirmationOptions): Promise<OBResponse>;
 }
 export declare class RequestException extends Error {
     constructor(error: string, options?: ErrorOptions);
@@ -653,7 +737,11 @@ export declare enum UnsupportedProductReason {
     /**
      * The recipient is not capable to receive the payment product.
      */
-    Recipient = "RECIPIENT"
+    Recipient = "RECIPIENT",
+    /**
+     * Scheduled payments are not supported.
+     */
+    Scheduled = "SCHEDULED"
 }
 export declare class PaymentFailedException extends Error {
     constructor(code?: string, userMessage?: string, options?: ErrorOptions);

package/index.js

@@ -41,7 +41,7 @@ function bytesToUtf8(bytes) {
     });
 }
 
-var version = "0.4.8";
+var version = "0.5.0";
 
 var AccountField;
 (function (AccountField) {
@@ -164,6 +164,59 @@ function _mapAccountType(type) {
             throw new TypeError("unknown value for `AccountType`: " + type);
     }
 }
+var PaymentProduct;
+(function (PaymentProduct) {
+    /**
+     * SEPA Credit Transfer (SCT) in EUR
+     */
+    PaymentProduct["SepaCreditTransfer"] = "SEPA_CREDIT_TRANSFER";
+    /**
+     * SEPA Instant Credit Transfer (SCT Inst) in EUR
+     */
+    PaymentProduct["SepaInstantCreditTransfer"] = "SEPA_INSTANT_CREDIT_TRANSFER";
+    /**
+     * Default SEPA Credit Transfer in EUR
+     *
+     * Tries SCT Inst with a fallback to SCT if this is supported.
+     * Otherwise, SCT is used.
+     */
+    PaymentProduct["DefaultSepaCreditTransfer"] = "DEFAULT_SEPA_CREDIT_TRANSFER";
+    /**
+     * International credit transfer outside of SEPA (typically SWIFT)
+     */
+    PaymentProduct["CrossBorderCreditTransfer"] = "CROSS_BORDER_CREDIT_TRANSFER";
+    /**
+     * Domestic credit transfer in the domestic, non-EUR currency
+     */
+    PaymentProduct["DomesticCreditTransfer"] = "DOMESTIC_CREDIT_TRANSFER";
+    /**
+     * Instant domestic credit transfer in the domestic, non-EUR currency
+     */
+    PaymentProduct["DomesticInstantCreditTransfer"] = "DOMESTIC_INSTANT_CREDIT_TRANSFER";
+})(PaymentProduct || (PaymentProduct = {}));
+function _mapPaymentProduct(product) {
+    switch (product) {
+        case PaymentProduct.SepaCreditTransfer:
+            return "SepaCreditTransfer";
+        case PaymentProduct.SepaInstantCreditTransfer:
+            return "SepaInstantCreditTransfer";
+        case PaymentProduct.DefaultSepaCreditTransfer:
+            return "DefaultSepaCreditTransfer";
+        case PaymentProduct.CrossBorderCreditTransfer:
+            return "CrossBorderCreditTransfer";
+        case PaymentProduct.DomesticCreditTransfer:
+            return "DomesticCreditTransfer";
+        case PaymentProduct.DomesticInstantCreditTransfer:
+            return "DomesticInstantCreditTransfer";
+    }
+}
+var ChargeBearer;
+(function (ChargeBearer) {
+    ChargeBearer["BorneByDebtor"] = "DEBT";
+    ChargeBearer["BorneByCreditor"] = "CRED";
+    ChargeBearer["Shared"] = "SHAR";
+    ChargeBearer["FollowingServiceLevel"] = "SLEV";
+})(ChargeBearer || (ChargeBearer = {}));
 /**
  * Response from YAXI Open Banking services.
  *
@@ -538,6 +591,12 @@ class RoutexClient {
             return yield this._unsealBody(response, { fallback: false });
         });
     }
+    /**
+     * System version for the currently established session
+     */
+    systemVersion() {
+        return this._settlement.systemVersion();
+    }
     /**
      * Search for service connections (banks and other providers)
      *
@@ -752,6 +811,38 @@ class RoutexClient {
             return yield this._confirm("collect-payment", options);
         });
     }
+    /**
+     * [Transfer service]{@link https://docs.yaxi.tech/transfer.html}
+     */
+    transfer(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ credentials, session, recurringConsents, ticket, product, debtorAccount, debtorName, requestedExecutionDate, details, }) {
+            const data = _prepareData(credentials, session, recurringConsents, {
+                product: _mapPaymentProduct(product),
+                debtorAccount,
+                debtorName,
+                requestedExecutionDate,
+                details,
+            });
+            const r = yield this._request(ticket, "transfer/service", data);
+            return _readOBResponse(r);
+        });
+    }
+    /**
+     * Respond to {@link Dialog} returned while initiating the transfer
+     */
+    respondTransfer(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._respond("transfer", options);
+        });
+    }
+    /**
+     * Confirm {@link Dialog} or {@link Redirect} returned initiating the transfer
+     */
+    confirmTransfer(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._confirm("transfer", options);
+        });
+    }
 }
 function _prepareData({ connectionId, userId, password, connectionData }, session, recurringConsents, data) {
     return Object.assign({ credentials: {
@@ -791,7 +882,7 @@ function _mapFilter(filter) {
     if ("any" in filter) {
         let other;
         if (filter.any.length > 2) {
-            other = { all: filter.any.slice(1) };
+            other = { any: filter.any.slice(1) };
         }
         else {
             other = filter.any[1];
@@ -850,7 +941,7 @@ function _responseError(response) {
                 return new UnsupportedProductException(error.UnsupportedProduct.reason, error.UnsupportedProduct.userMessage);
             }
             if ("PaymentFailed" in error) {
-                return new PaymentFailedException(error.PaymentFailed.code, error.userMessage);
+                return new PaymentFailedException(error.PaymentFailed.code, error.PaymentFailed.userMessage);
             }
             if ("UnexpectedValue" in error) {
                 return new UnexpectedValueException(error.UnexpectedValue.error);
@@ -962,6 +1053,9 @@ class UnsupportedProductException extends Error {
             case "Recipient":
                 this.reason = UnsupportedProductReason.Recipient;
                 break;
+            case "Scheduled":
+                this.reason = UnsupportedProductReason.Scheduled;
+                break;
         }
         this.userMessage = userMessage;
     }
@@ -976,6 +1070,10 @@ var UnsupportedProductReason;
      * The recipient is not capable to receive the payment product.
      */
     UnsupportedProductReason["Recipient"] = "RECIPIENT";
+    /**
+     * Scheduled payments are not supported.
+     */
+    UnsupportedProductReason["Scheduled"] = "SCHEDULED";
 })(UnsupportedProductReason || (UnsupportedProductReason = {}));
 class PaymentFailedException extends Error {
     constructor(code, userMessage, options) {
@@ -1178,4 +1276,4 @@ function clearCredentials() {
     }
 }
 
-export { AccessExceededException, AccountField, AccountStatus, AccountType, CanceledException, Confirmation, ConsentExpiredException, Dialog, DialogContext, Field, InputType, InvalidCredentialsException, NotFoundException, OBResponse, PaymentFailedCode, PaymentFailedException, PeriodOutOfBoundsException, ProviderErrorCode, ProviderErrorException, Redirect, RedirectHandle, RequestException, ResponseException, Result, RoutexClient, SecrecyLevel, Selection, ServiceBlockedCode, ServiceBlockedException, SupportedService, TicketException, TicketExceptionCode, UnauthorizedException, UnexpectedErrorException, UnexpectedValueException, UnsupportedProductException, UnsupportedProductReason, _testing, clearCredentials, loadCredentials, removeCredentials, retryRequestExceptionNTimesPolicy, storeCredentials };
+export { AccessExceededException, AccountField, AccountStatus, AccountType, CanceledException, ChargeBearer, Confirmation, ConsentExpiredException, Dialog, DialogContext, Field, InputType, InvalidCredentialsException, NotFoundException, OBResponse, PaymentFailedCode, PaymentFailedException, PaymentProduct, PeriodOutOfBoundsException, ProviderErrorCode, ProviderErrorException, Redirect, RedirectHandle, RequestException, ResponseException, Result, RoutexClient, SecrecyLevel, Selection, ServiceBlockedCode, ServiceBlockedException, SupportedService, TicketException, TicketExceptionCode, UnauthorizedException, UnexpectedErrorException, UnexpectedValueException, UnsupportedProductException, UnsupportedProductReason, _testing, clearCredentials, loadCredentials, removeCredentials, retryRequestExceptionNTimesPolicy, storeCredentials };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "routex-client",
-  "version": "0.4.8",
+  "version": "0.5.0",
   "description": "YAXI routex client",
   "homepage": "https://yaxi.tech",
   "author": "YAXI GmbH",
@@ -24,7 +24,7 @@
   "dependencies": {
     "@noble/ciphers": "^2.0.0",
     "jwt-decode": "^4.0.0",
-    "routex-settlement": "^0.1.4"
+    "routex-settlement": "^0.2.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.18.0",