From ce5566366a6c4f9d1fc66b30affa6fd3d0d23324 Mon Sep 17 00:00:00 2001
From: iamshabell <91321698+iamshabell@users.noreply.github.com>
Date: Fri, 15 Dec 2023 19:14:48 +0300
Subject: [PATCH] add(README): payment response details

---
 README.md                  | 12 ++++++++++++
 packages/marupay/README.md | 12 ++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 05ec54f..bd901d9 100644
--- a/README.md
+++ b/README.md
@@ -97,6 +97,18 @@ app.listen(port, () => {
 });
 ```
 
+### Responses
+
+The `credit` and `request` methods both returns a `PaymentInfo` object. It'll return these details:
+
+- **`transactionId`:** This identifier is obtained from the vendor's transaction ID. It uniquely identifies the transaction in the vendor's system.
+
+- **`paymentStatus`:** The payment status is also retrieved from the vendor's response. It indicates the current status of the payment transaction in the vendor's system.
+
+- **`referenceId`:** The reference ID is specific to Marupay and is provided in Marupay's response. It serves as a unique identifier for the transaction within Marupay's system.
+
+- **`raw`:** This will return unfiltered response details from the vendor.
+
 ### Examples
 
 The provided examples demonstrate how to use the Marupay SDK for both purchase and credit transactions with eDahab and Waafi payment handlers. Customize the route handlers according to your application's needs.
diff --git a/packages/marupay/README.md b/packages/marupay/README.md
index 1eb94f1..a09125a 100644
--- a/packages/marupay/README.md
+++ b/packages/marupay/README.md
@@ -96,6 +96,18 @@ app.listen(port, () => {
     console.log(`Server is listening at http://localhost:${port}`);
 });
 ```
+### Responses
+
+The `credit` and `request` methods both returns a `PaymentInfo` object. It'll return these details:
+
+- **`transactionId`:** This identifier is obtained from the vendor's transaction ID. It uniquely identifies the transaction in the vendor's system.
+
+- **`paymentStatus`:** The payment status is also retrieved from the vendor's response. It indicates the current status of the payment transaction in the vendor's system.
+
+- **`referenceId`:** The reference ID is specific to Marupay and is provided in Marupay's response. It serves as a unique identifier for the transaction within Marupay's system.
+
+- **`raw`:** This will return unfiltered response details from the vendor.
+
 
 ### Examples