telebirr-nodejs 1.0.6 → 1.0.8

package/README.md

@@ -21,13 +21,13 @@ You should never hard-code secrets. Always load them from process.env.
 
 ### Required Credentials
 
-| Name                   | Description                  |
-| ---------------------- | ---------------------------- |
-| `FABRIC_APP_ID`        | Fabric application ID        |
-| `FABRIC_APP_SECRET`    | Fabric application secret    |
-| `MERCHANT_APP_ID`      | Merchant application ID      |
-| `MERCHANT_CODE`        | Merchant code                |
-| `MERCHANT_PRIVATE_KEY` | RSA private key (PEM string) |
+| Name                   | Description                                                                            |
+| ---------------------- | -------------------------------------------------------------------------------------- |
+| `FABRIC_APP_ID`        | Fabric application ID (c4182ef8-9249-458a-985e-06d191f4d505 uuid-v4 string)            |
+| `FABRIC_APP_SECRET`    | Fabric application secret ("fad0f06383c6297f54rr78694b974599" 32 hex character string) |
+| `MERCHANT_APP_ID`      | Merchant application ID ("7606201678956824" 16 integer character string)               |
+| `MERCHANT_CODE`        | Merchant code ("000000" 6 integer character string)                                    |
+| `MERCHANT_PRIVATE_KEY` | RSA private key (PEM string)                                                           |
 
 ---
 
@@ -42,6 +42,8 @@ You should never hard-code secrets. Always load them from process.env.
 
 ### Basic Setup
 
+---
+
 ```bash
 import { TelebirrClient } from "telebirr-nodejs";
 
@@ -51,7 +53,7 @@ const client = new TelebirrClient({
   appSecret: process.env.FABRIC_APP_SECRET!,
   merchantAppId: process.env.MERCHANT_APP_ID!,
   merchantCode: process.env.MERCHANT_CODE!,
-  privateKey: process.env.MERCHANT_PRIVATE_KEY!,
+  merchantPrivateKey: process.env.MERCHANT_PRIVATE_KEY!,
   notifyUrl: process.env.TELEBIRR_NOTIFY_URL!,
   redirectUrl: process.env.TELEBIRR_REDIRECT_URL!,
   http: true, // allow HTTP in simulator mode
@@ -75,15 +77,13 @@ MERCHANT_PRIVATE_KEY must be the full PEM string, including:
 
 ### Example API Routes
 
-Below is a complete demo using three routes:
-
 1. POST /payment/initiate
-2. GET /payment/status/:merchOrderId
+2. GET /payment/status
 3. POST /payment/refund
 
 ---
 
-### 1 Initiate Payment
+### 1. Initiate Payment
 
 Creates an order and redirects the user to the Telebirr checkout page.
 
@@ -104,7 +104,7 @@ If you are using a frontend framework (for example React) and do not want to los
 
 ---
 
-### 2 Query Payment Status
+### 2. Query Payment Status
 
 Used to check the payment result using the merchant order ID.
 
@@ -123,13 +123,12 @@ https://developer.ethiotelecom.et/docs/H5%20C2B%20Web%20Payment%20Integration%20
 
 ---
 
-### 3 Refund Payment
+### 3. Refund Payment
 
 Refunds a completed transaction.
 
 ```bash
 app.post("/payment/refund", async (req, res) => {
-
     const refundData = await client.refundOrder({
         merchOrderId: "order123",
         refundRequestNo: "original-transaction-id",
@@ -138,7 +137,7 @@ app.post("/payment/refund", async (req, res) => {
     });
 
     res.json(refundData);
-    });
+});
 
 ```
 
@@ -154,13 +153,13 @@ To use the simulator provided by this package, set the mode to simulate.
 ```bash
 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",
-    });
+const client = new TelebirrClient({
+    mode: "simulate",
+    notifyUrl: "https://example.com/notify",
+    redirectUrl: "https://example.com/redirect",
+    http: true,
+    IntegrationOption: "C2B",
+});
 
 ```
 
@@ -192,12 +191,12 @@ 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,
+});
 
 ```
 

package/package.json

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