Skip to content

Commit

Permalink
add(docs): details on 'credit' and 'request' method responses
Browse files Browse the repository at this point in the history
  • Loading branch information
iamshabell committed Dec 11, 2023
1 parent 454be02 commit adcf497
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
13 changes: 12 additions & 1 deletion apps/docs/pages/guide/credit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,15 @@ app.get('/purchase', async (req, res) => {
});


```
```

The `credit` method 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.

These details are essential for tracking and reconciling transactions between your application, the vendor, and Marupay. Ensure that you appropriately handle and store these values for accurate record-keeping and future reference.

11 changes: 10 additions & 1 deletion apps/docs/pages/guide/purchase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,14 @@ app.get('/credit', async (req, res) => {
}
});

```

```
It'll return the same response detail as from [`credit`](credit.mdx) method `PaymentInfo` object:

- **`transactionId`**

- **`paymentStatus`**

- **`referenceId`**

Feel free to incorporate these details into your application's logic based on your specific use case and requirements.

0 comments on commit adcf497

Please sign in to comment.