maib-mia-sdk 1.0.2 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "maib-mia-sdk",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "description": "Node.js SDK for maib MIA API",
     "keywords": [
         "maib",

package/src/MaibMiaApiRequest.js

@@ -53,17 +53,17 @@ class MaibMiaApiRequest {
     /**
      * Perform API request
      * @param {string} endpoint - API endpoint
+     * @param {string} authToken - Access token
      * @param {Object} data - Request data
-     * @param {string} token - Access token
      * @param {string[]} requiredParams - Array of required field names
      * @param {string} method - Request HTTP method
      * @param {Object} params - Request params
      */
-    async _executeOperation(endpoint, token, data=null, requiredParams=null, method='POST', params=null) {
-        MaibMiaApiRequest._validateAccessToken(token);
+    async _executeOperation(endpoint, authToken, data = null, requiredParams = null, method = 'POST', params = null) {
+        MaibMiaApiRequest._validateAccessToken(authToken);
         MaibMiaApiRequest._validateParams(data, requiredParams);
 
-        return this.client._sendRequest(method, endpoint, data, params, token);
+        return this.client._sendRequest(method, endpoint, data, params, authToken);
     }
 
     /**
@@ -96,11 +96,11 @@ class MaibMiaApiRequest {
 
     /**
      * Validates the access token
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @throws {MaibMiaValidationError} - If Access token parameter is invalid
      */
-    static _validateAccessToken(token) {
-        if (!token) {
+    static _validateAccessToken(authToken) {
+        if (!authToken) {
             throw new MaibMiaValidationError('Access token is required');
         }
     }
@@ -121,7 +121,7 @@ class MaibMiaApiRequest {
         }
 
         const missingParams = requiredParams.filter(field =>
-            data[field] === undefined || data[field] === null
+            data[field] == null
         );
 
         if (missingParams.length > 0) {
@@ -134,87 +134,87 @@ class MaibMiaApiRequest {
     /**
      * Create QR Code (Static, Dynamic)
      * @param {Object} data - QR code data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - QR creation response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/overview/mia-qr-types
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-initiation/create-qr-code-static-dynamic
      */
-    async qrCreate(data, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_QR, token, data, REQUIRED_PARAMS.QR_PARAMS);
+    async qrCreate(data, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_QR, authToken, data, REQUIRED_PARAMS.QR_PARAMS);
     }
 
     /**
      * Create Hybrid QR Code
      * @param {Object} data - QR code data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - QR creation response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/overview/mia-qr-types
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-initiation/create-hybrid-qr-code
      */
-    async qrCreateHybrid(data, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_QR_HYBRID, token, data, REQUIRED_PARAMS.QR_HYBRID_PARAMS);
+    async qrCreateHybrid(data, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_QR_HYBRID, authToken, data, REQUIRED_PARAMS.QR_HYBRID_PARAMS);
     }
 
     /**
      * Create Extension for QR Code by ID
      * @param {string} qrId - QR code ID
      * @param {Object} data - QR code extension data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - QR creation response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-initiation/create-hybrid-qr-code/create-extension-for-qr-code-by-id
      */
-    async qrCreateExtension(qrId, data, token) {
+    async qrCreateExtension(qrId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_QR_EXTENSION, { qrId });
-        return this._executeOperation(endpoint, token, data, REQUIRED_PARAMS.QR_EXTENSION_PARAMS);
+        return this._executeOperation(endpoint, authToken, data, REQUIRED_PARAMS.QR_EXTENSION_PARAMS);
     }
 
     /**
      * Retrieve QR Details by ID
      * @param {string} qrId - QR code ID
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - QR details
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/information-retrieval-get/retrieve-qr-details-by-id
      */
-    async qrDetails(qrId, token) {
+    async qrDetails(qrId, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_QR_ID, { qrId });
-        return this._executeOperation(endpoint, token, null, null, 'GET');
+        return this._executeOperation(endpoint, authToken, null, null, 'GET');
     }
 
     /**
      * Cancel Active QR (Static, Dynamic)
      * @param {string} qrId - QR code ID
      * @param {Object} data - QR code cancellation data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Cancellation response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-cancellation/cancel-active-qr-static-dynamic
      */
-    async qrCancel(qrId, data, token) {
+    async qrCancel(qrId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_QR_CANCEL, { qrId });
-        return this._executeOperation(endpoint, token, data);
+        return this._executeOperation(endpoint, authToken, data);
     }
 
     /**
      * Cancel Active QR Extension (Hybrid)
      * @param {string} qrId - QR code ID
      * @param {Object} data - QR code extension cancellation data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Cancellation response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-cancellation/cancel-active-qr-extension-hybrid
      */
-    async qrCancelExtension(qrId, data, token) {
+    async qrCancelExtension(qrId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_QR_EXTENSION_CANCEL, { qrId });
-        return this._executeOperation(endpoint, token, data);
+        return this._executeOperation(endpoint, authToken, data);
     }
 
     /**
      * Retrieve List of QR Codes with Filtering Options
      * @param {Object} params - Retrieval params
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Retrieval response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/information-retrieval-get/display-list-of-qr-codes-with-filtering-options
      */
-    async qrList(params, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_QR, token, null, null, 'GET', params);
+    async qrList(params, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_QR, authToken, null, null, 'GET', params);
     }
     //#endregion
 
@@ -222,48 +222,48 @@ class MaibMiaApiRequest {
     /**
      * Payment Simulation (Sandbox)
      * @param {Object} data - Test payment data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Test payment response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/payment-simulation-sandbox
      */
-    async testPay(data, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_TEST_PAY, token, data, REQUIRED_PARAMS.TEST_PAY_PARAMS);
+    async testPay(data, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_TEST_PAY, authToken, data, REQUIRED_PARAMS.TEST_PAY_PARAMS);
     }
 
     /**
      * Retrieve Payment Details by ID
      * @param {string} payId - Payment ID
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Payment details response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/information-retrieval-get/retrieve-payment-details-by-id
      */
-    async paymentDetails(payId, token) {
+    async paymentDetails(payId, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_PAYMENTS_ID, { payId });
-        return this._executeOperation(endpoint, token, null, null, 'GET');
+        return this._executeOperation(endpoint, authToken, null, null, 'GET');
     }
 
     /**
      * Refund Completed Payment
      * @param {string} payId - Payment ID
      * @param {Object} data - Refund data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Refund response
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-refund/refund-completed-payment
      */
-    async paymentRefund(payId, data, token) {
+    async paymentRefund(payId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.PAYMENTS_REFUND, { payId });
-        return this._executeOperation(endpoint, token, data);
+        return this._executeOperation(endpoint, authToken, data, REQUIRED_PARAMS.PAYMENTS_REFUND_PARAMS);
     }
 
     /**
      * Retrieve List of Payments with Filtering Options
      * @param {Object} params - Retrieval params
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @link https://docs.maibmerchants.md/mia-qr-api/en/endpoints/information-retrieval-get/retrieve-list-of-payments-with-filtering-options
      * @returns {Promise<Object>} - Retrieval response
      */
-    async paymentList(params, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_PAYMENTS, token, null, null, 'GET', params);
+    async paymentList(params, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_PAYMENTS, authToken, null, null, 'GET', params);
     }
     //#endregion
 
@@ -271,86 +271,86 @@ class MaibMiaApiRequest {
     /**
      * Create a new payment request (RTP)
      * @param {Object} data - RTP data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - RTP creation response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/endpoints/create-a-new-payment-request-rtp
      */
-    async rtpCreate(data, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_RTP, token, data, REQUIRED_PARAMS.RTP_PARAMS);
+    async rtpCreate(data, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_RTP, authToken, data, REQUIRED_PARAMS.RTP_PARAMS);
     }
 
     /**
      * Retrieve the status of a payment request
      * @param {string} rtpId - RTP ID
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - RTP status response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/endpoints/retrieve-the-status-of-a-payment-request
      */
-    async rtpStatus(rtpId, token) {
+    async rtpStatus(rtpId, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_RTP_ID, { rtpId });
-        return this._executeOperation(endpoint, token, null, null, 'GET');
+        return this._executeOperation(endpoint, authToken, null, null, 'GET');
     }
 
     /**
      * Cancel a pending payment request
      * @param {string} rtpId - RTP ID
      * @param {Object} data - RTP cancellation data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - RTP cancellation response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/endpoints/cancel-a-pending-payment-request
      */
-    async rtpCancel(rtpId, data, token) {
+    async rtpCancel(rtpId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_RTP_CANCEL, { rtpId });
-        return this._executeOperation(endpoint, token, data);
+        return this._executeOperation(endpoint, authToken, data);
     }
 
     /**
      * List all payment requests
      * @param {Object} params - Retrieval params
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Retrieval response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/endpoints/list-all-payment-requests
      */
-    async rtpList(params, token) {
-        return this._executeOperation(API_ENDPOINTS.MIA_RTP, token, null, null, 'GET', params);
+    async rtpList(params, authToken) {
+        return this._executeOperation(API_ENDPOINTS.MIA_RTP, authToken, null, null, 'GET', params);
     }
 
     /**
      * Initiate a refund for a completed payment
      * @param {string} payId - Payment ID
      * @param {Object} data - Refund data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Refund response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/endpoints/initiate-a-refund-for-a-completed-payment
      */
-    async rtpRefund(payId, data, token) {
+    async rtpRefund(payId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_RTP_REFUND, { payId });
-        return this._executeOperation(endpoint, token, data);
+        return this._executeOperation(endpoint, authToken, data);
     }
 
     /**
      * Simulate acceptance of a payment request
      * @param {string} rtpId - RTP ID
      * @param {Object} data - Test payment data
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Test accept response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/sandbox-simulation-environment/simulate-acceptance-of-a-payment-request
      */
-    async rtpTestAccept(rtpId, data, token) {
+    async rtpTestAccept(rtpId, data, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_RTP_TEST_ACCEPT, { rtpId });
-        return this._executeOperation(endpoint, token, data, REQUIRED_PARAMS.TEST_ACCEPT_PARAMS);
+        return this._executeOperation(endpoint, authToken, data, REQUIRED_PARAMS.TEST_ACCEPT_PARAMS);
     }
 
     /**
      * Simulate rejection of a payment request
      * @param {string} rtpId - RTP ID
-     * @param {string} token - Access token
+     * @param {string} authToken - Access token
      * @returns {Promise<Object>} - Test reject response
      * @link https://docs.maibmerchants.md/request-to-pay/api-reference/sandbox-simulation-environment/simulate-rejection-of-a-payment-request
      */
-    async rtpTestReject(rtpId, token) {
+    async rtpTestReject(rtpId, authToken) {
         const endpoint = MaibMiaApiRequest._buildEndpoint(API_ENDPOINTS.MIA_RTP_TEST_REJECT, { rtpId });
-        return this._executeOperation(endpoint, token);
+        return this._executeOperation(endpoint, authToken);
     }
     //#endregion
 }

package/src/MaibMiaSdk.js

@@ -30,15 +30,15 @@ class MaibMiaSdk {
         });
     }
 
-    setupLogging() {
+    setupLogging(logger = console) {
         this.client.interceptors.request.use(
             (config) => {
                 const logData = MaibMiaSdk._getLogData(config, config);
-                console.debug(`${packageName} Request: ${logData.method} ${logData.url}`, logData);
+                logger.debug(`${packageName} Request: ${logData.method} ${logData.url}`, logData);
                 return config;
             },
             (error) => {
-                console.error(`${packageName} Request: ${error.message}`, error);
+                logger.error(`${packageName} Request: ${error.message}`, error);
                 return Promise.reject(error);
             }
         );
@@ -46,13 +46,13 @@ class MaibMiaSdk {
         this.client.interceptors.response.use(
             (response) => {
                 const logData = MaibMiaSdk._getLogData(response, response?.config);
-                console.debug(`${packageName} Response: ${logData.status} ${logData.method} ${logData.url}`, logData);
+                logger.debug(`${packageName} Response: ${logData.status} ${logData.method} ${logData.url}`, logData);
                 return response;
             },
             (error) => {
                 const config = error.response?.config || error.config;
                 const logData = MaibMiaSdk._getLogData(error.response, config);
-                console.error(`${packageName} Error: ${logData.status ?? ''} ${logData.data ?? ''}`, logData, error);
+                logger.error(`${packageName} Error: ${logData.status ?? ''} ${logData.data ?? ''}`, logData, error);
                 return Promise.reject(error);
             }
         );
@@ -210,9 +210,7 @@ class MaibMiaSdk {
         const hashInput = `${additionalString}:${signatureKey}`;
 
         // Hash and base64 encode
-        const hash = crypto.createHash('sha256').update(hashInput, 'utf8').digest('base64');
-
-        return hash;
+        return crypto.createHash('sha256').update(hashInput, 'utf8').digest('base64');
     }
 }
 

package/src/constants.js

@@ -48,6 +48,8 @@ const REQUIRED_PARAMS = {
     QR_EXTENSION_PARAMS: ['expiresAt', 'description'],
     // https://docs.maibmerchants.md/mia-qr-api/en/payment-simulation-sandbox#request-parameters-body-json
     TEST_PAY_PARAMS: ['qrId', 'amount', 'iban', 'currency', 'payerName'],
+    // https://docs.maibmerchants.md/mia-qr-api/en/endpoints/payment-refund/refund-completed-payment
+    PAYMENTS_REFUND_PARAMS: ['reason'],
     // https://docs.maibmerchants.md/request-to-pay/api-reference/endpoints/create-a-new-payment-request-rtp#request-body-parameters
     RTP_PARAMS: ['alias', 'amount', 'currency', 'expiresAt', 'description'],
     // https://docs.maibmerchants.md/request-to-pay/api-reference/sandbox-simulation-environment/simulate-acceptance-of-a-payment-request#request-body-parameters