mts-booking-library 3.1.0 → 3.2.0

package/lib/booking/booking.d.ts

@@ -78,11 +78,13 @@ export declare abstract class Booking {
     /**
      * @description This method shall be used to get all necessary informations to initialize a payment with a certain gateway.
      * @param gatewayId The id of the gateway to use. Its value shall be taken from the response of the {@link Booking.getSellerGateways} API
-     * @param returnUrl The url to which the user will be redirected after the payment. This value shall be set only if the
-     * chosen gateway is {@link GatewayTypes.PAYPAL} or {@link GatewayTypes.WORLDLINE}
+     * @param returnOrigin The FE origin (scheme+host+port, e.g. `window.location.origin`) that the gateway should redirect
+     * back to after the payment. The BE validates this against a per-app allowlist and stitches the canonical
+     * `/booking?step=BOOKING_STEP_PAYMENT_PROCESSING&cartGuid={guid}` path on top. Pass `window.location.origin` from the
+     * caller — the BE owns the rest. Replaces the legacy full-URL `returnUrl` parameter (BE 3.2.0+).
      * @returns An {@link ErrorResponse} object in case of error, a {@link GetPaymentInformationFromGatewayResponse} object otherwise.
      */
-    getPaymentInformationFromGateway(gatewayId: number, returnUrl?: string, options?: ApiCallOptions): Promise<ErrorResponse | GetPaymentInformationFromGatewayResponse>;
+    getPaymentInformationFromGateway(gatewayId: number, returnOrigin: string, options?: ApiCallOptions): Promise<ErrorResponse | GetPaymentInformationFromGatewayResponse>;
     /**
      * @description This method shall be used to issue the tickets. It must be called after the payment was successful.
      * @param paymentMethod The payment method used to pay the cart. If the chosen method is {@link PaymentMethods.ZERO_COST},

package/lib/booking/booking.js

@@ -285,11 +285,13 @@ var Booking = /** @class */ (function () {
     /**
      * @description This method shall be used to get all necessary informations to initialize a payment with a certain gateway.
      * @param gatewayId The id of the gateway to use. Its value shall be taken from the response of the {@link Booking.getSellerGateways} API
-     * @param returnUrl The url to which the user will be redirected after the payment. This value shall be set only if the
-     * chosen gateway is {@link GatewayTypes.PAYPAL} or {@link GatewayTypes.WORLDLINE}
+     * @param returnOrigin The FE origin (scheme+host+port, e.g. `window.location.origin`) that the gateway should redirect
+     * back to after the payment. The BE validates this against a per-app allowlist and stitches the canonical
+     * `/booking?step=BOOKING_STEP_PAYMENT_PROCESSING&cartGuid={guid}` path on top. Pass `window.location.origin` from the
+     * caller — the BE owns the rest. Replaces the legacy full-URL `returnUrl` parameter (BE 3.2.0+).
      * @returns An {@link ErrorResponse} object in case of error, a {@link GetPaymentInformationFromGatewayResponse} object otherwise.
      */
-    Booking.prototype.getPaymentInformationFromGateway = function (gatewayId, returnUrl, options) {
+    Booking.prototype.getPaymentInformationFromGateway = function (gatewayId, returnOrigin, options) {
         return __awaiter(this, void 0, void 0, function () {
             var issueStep, searchParams, url;
             return __generator(this, function (_a) {
@@ -301,7 +303,7 @@ var Booking = /** @class */ (function () {
                 if (!issueStep || !issueStep[0]) {
                     throw Error("The status of the cart does not allow to call this API");
                 }
-                searchParams = new URLSearchParams(__assign({ gatewayId: gatewayId.toString(), cartGuid: this.cartGuid }, (returnUrl && { returnUrl: returnUrl })));
+                searchParams = new URLSearchParams(__assign({ gatewayId: gatewayId.toString(), cartGuid: this.cartGuid }, (returnOrigin && { returnOrigin: returnOrigin })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_payment/paymentInformation?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",