telebirr-nodejs 1.0.5 → 1.0.6

package/README.md

@@ -10,11 +10,15 @@ A simple, opinionated Node.js SDK for integrating **Telebirr C2B payments** with
 npm install telebirr-nodejs
 ```
 
+---
+
 ## Required Configuration
 
 Telebirr requires credentials and callback URLs.
 You should never hard-code secrets. Always load them from process.env.
 
+---
+
 ### Required Credentials
 
 | Name                   | Description                  |
@@ -25,6 +29,8 @@ You should never hard-code secrets. Always load them from process.env.
 | `MERCHANT_CODE`        | Merchant code                |
 | `MERCHANT_PRIVATE_KEY` | RSA private key (PEM string) |
 
+---
+
 ### Required URLs
 
 | Name                    | Description                     |
@@ -32,6 +38,8 @@ You should never hard-code secrets. Always load them from process.env.
 | `TELEBIRR_NOTIFY_URL`   | Server-to-server callback URL   |
 | `TELEBIRR_REDIRECT_URL` | User redirect URL after payment |
 
+---
+
 ### Basic Setup
 
 ```bash
@@ -51,6 +59,8 @@ const client = new TelebirrClient({
 });
 ```
 
+---
+
 ### Important
 
 MERCHANT_PRIVATE_KEY must be the full PEM string, including:
@@ -61,13 +71,17 @@ MERCHANT_PRIVATE_KEY must be the full PEM string, including:
 -----END RSA PRIVATE KEY-----
 ```
 
+---
+
 ### Example API Routes
 
 Below is a complete demo using three routes:
 
-POST /payment/initiate
-GET /payment/status/:merchOrderId
-POST /payment/refund
+1. POST /payment/initiate
+2. GET /payment/status/:merchOrderId
+3. POST /payment/refund
+
+---
 
 ### 1 Initiate Payment
 
@@ -76,11 +90,11 @@ Creates an order and redirects the user to the Telebirr checkout page.
 ```bash
 app.post("/payment/initiate", async (req, res) => {
     const checkoutUrl = await client.preOrder({
-            merchOrderId: "order123",
-            title: "Phone",
-            amount: "12",
-            callbackInfo: "from web checkout",
-        });
+        merchOrderId: "order123",
+        title: "Phone",
+        amount: "12",
+        callbackInfo: "from web checkout",
+    });
 
     res.redirect(checkoutUrl);
 });
@@ -88,6 +102,8 @@ app.post("/payment/initiate", async (req, res) => {
 
 If you are using a frontend framework (for example React) and do not want to lose application state, return the checkout URL as JSON and let the frontend handle the redirection.
 
+---
+
 ### 2 Query Payment Status
 
 Used to check the payment result using the merchant order ID.
@@ -102,6 +118,11 @@ app.get("/payment/status/:merchOrderId", async (req, res) => {
 });
 ```
 
+Please refer to Telebirr’s official documentation to correctly handle the query order json response:
+https://developer.ethiotelecom.et/docs/H5%20C2B%20Web%20Payment%20Integration%20Quick%20Guide/queryOrder
+
+---
+
 ### 3 Refund Payment
 
 Refunds a completed transaction.
@@ -117,10 +138,14 @@ app.post("/payment/refund", async (req, res) => {
     });
 
     res.json(refundData);
-});
+    });
+
 ```
 
-Refund amount must not exceed the original payment amount
+Please refer to Telebirr’s official documentation to correctly handle the refund order json response:
+https://developer.ethiotelecom.et/docs/H5%20C2B%20Web%20Payment%20Integration%20Quick%20Guide/RefundOrder
+
+---
 
 ### Simulator Mode
 
@@ -130,31 +155,36 @@ To use the simulator provided by this package, set the mode to simulate.
 import { TelebirrClient } from "telebirr-nodejs";
 
     const client = new TelebirrClient({
-            mode: "simulate",
-            notifyUrl: "https://example.com/notify",
-            redirectUrl: "https://example.com/redirect",
-            http: true,
-            IntegrationOption: "C2B",
-        });
+        mode: "simulate",
+        notifyUrl: "https://example.com/notify",
+        redirectUrl: "https://example.com/redirect",
+        http: true,
+        IntegrationOption: "C2B",
+    });
+
 ```
 
 This simulator is for learning and development purposes only.
 The simulation server is provided by this package, not by Telebirr. For real testing, use Telebirr’s sandbox mode and whitelist your public IP address in the Telebirr portal.
 
+---
+
 ### Supported Features
 
-Fabric token handling
-RSA-SHA256 request signing
-C2B checkout
-Order query
-Refunds
-Simulator support
-Notify URL Handling
+- Fabric token handling
+- RSA-SHA256 request signing
+- C2B checkout
+- Order query
+- Refunds
+- Simulator support
+- Notify URL Handling
 
 Please refer to Telebirr’s official documentation to correctly handle notify callbacks:
 
 https://developer.ethiotelecom.et/docs/H5%20C2B%20Web%20Payment%20Integration%20Quick%20Guide/Notify_Callback
 
+---
+
 ### RSA Key Generation
 
 You can generate private and public keys instantly.
@@ -162,12 +192,13 @@ You can generate private and public keys instantly.
 ```bash
 import { generateKeys } from "telebirr-nodejs";
 
-generateKeys({
-    dir: process.cwd(),
-    privateKeyName: "telefy_private.pem",
-    publicKeyName: "telefy_public.pem",
-    overwrite: false,
-});
+    generateKeys({
+        dir: process.cwd(),
+        privateKeyName: "telefy_private.pem",
+        publicKeyName: "telefy_public.pem",
+        overwrite: false,
+    });
+
 ```
 
 This will generate two .pem files in your root directory.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "telebirr-nodejs",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Unofficial Telebirr Node.js SDK.",
   "type": "module",
   "main": "./dist/index.cjs",