xpay-redirect 1.1.0 → 1.2.0

package/README.md

@@ -1,41 +1,63 @@
 ## Installation
 
-`<script src="https://cdn.jsdelivr.net/npm/xpay-redirect@1.1.0/dist/index.min.js"></script>`
+XPay Redirection - used to show the payment gateway at the another page.
+
+Use this script tag to get access to the xpay redirection.
+
+`<script src="https://cdn.jsdelivr.net/npm/xpay-redirect@1.2.0/dist/index.min.js"></script>`
 
 ## Implementation
 
-1. open new page and implement this package.
+<b>Steps :-</b>
+
+1. Create two HTML files like `index.html` and `xpay.html`.
 
+2. Add a button or anchor tag at `index.html` to redirect to the `xpay.html` page.
+
+```html
+<a href="./xpay.html">paynow</a>
 ```
+
+3. At `xpay.html`. Add a div tag with the id `xpay-ftb-web-redirect` at the body tag. It is used to display the xpay module with the help of this id.
+
+```html
 <div id="xpay-ftb-web-redirect"></div>
+```
+
+4. Add a Script tag to the head tag or body tag. And use the latest version.
 
-<script src="https://cdn.jsdelivr.net/npm/xpay-redirect@1.1.0/dist/index.min.js"></script>
+```html
+<script src="https://cdn.jsdelivr.net/npm/xpay-redirect@1.2.0/dist/index.min.js"></script>
+```
 
+5. Next, add the script tag at a necessary place. But add below the source script.
+
+```html
 <script>
-    const config = {
-        baseurl:string,
-        transactionDetails: {
-            txid: number,
-            amount: number,
-            purchaseCurrency: string,
-            purchaseAmount: number,
-            expiryTime: string,
-        },
-        popupStatus: string, // if tx is PENDING send '' empty string or send tx status at popupStatus
-        sessionid: string,
-        paymenttokenid: string,
-        merchantName: string,
-        merchantUrl: string,
-        onResponse: function(data){},
-        onError: function(data){},
-        onPopupClose: function(data){}
-    };
-
-    xpayftb.XpayRedirect(config);
+	const config = {
+		baseurl: string,
+		sessionid: string,
+		paymenttokenid: string,
+		expiryTime: number,
+		merchantName: string,
+		merchantUrl: string,
+		onResponse: function (data) {},
+		onError: function (data) {},
+		onPopupClose: function (data) {}
+	};
+
+	xpayftb.XpayRedirect(config);
 </script>
 ```
 
+Here, the config variable is used to pass the data as an object to the xpayftb.
+`xpayftb.XpayRedirect(config)`
+
 ## Note
 
-- if transaction is PENDING send '' empty string or send transaction status at popupStatus
-- onResponse, onError and onPopupClose are function. Pass one parameter and to get access of it.
+- `baseurl` should pass as a string value. It is used as the base URL for API calls.
+- `sessionid` and `paymenttokenid` should pass as a string value. It is used all over the xpay.
+- `expiryTime` is used to display a countdown and to close the session. Try to send it in minutes and numerically (expected `3` or `5`).
+- `merchantName` is used to display the merchant name at xpay. And pass it as a string value.
+- `merchantUrl` should pass as a string value. It is used to return the merchant back to the checkout page or any URL.
+- `onResponse`, `onError` and `onPopupClose` are functions. Try to pass one parameter and console it to observe and customize according to the result.