Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add(README): payment response details #32

Merged
merged 1 commit into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading