Skip to content

Commit

Permalink
Merge pull request #32 from iamshabell/dev
Browse files Browse the repository at this point in the history
add(README): payment response details
  • Loading branch information
iamshabell authored Dec 15, 2023
2 parents f721f75 + ce55663 commit fe49e71
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 12 additions & 0 deletions packages/marupay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit fe49e71

Please sign in to comment.