Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remotemerge/esewa-php-sdk
Effortless and Secure eSewa Payment Gateway Integration in PHP.
https://github.com/remotemerge/esewa-php-sdk
api esewa gateway nepal payment php sdk
Last synced: 6 days ago
JSON representation
Effortless and Secure eSewa Payment Gateway Integration in PHP.
- Host: GitHub
- URL: https://github.com/remotemerge/esewa-php-sdk
- Owner: remotemerge
- License: mit
- Created: 2019-12-28T04:53:35.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T12:15:29.000Z (3 months ago)
- Last Synced: 2024-10-29T00:57:55.249Z (18 days ago)
- Topics: api, esewa, gateway, nepal, payment, php, sdk
- Language: PHP
- Homepage: https://github.com/remotemerge/esewa-php-sdk
- Size: 368 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eSewa SDK for PHP
[)](https://twitter.com/sapkotamadan)
[](https://www.facebook.com/NextSapkotaMadan)
[](https://packagist.org/packages/remotemerge/esewa-php-sdk)
The **eSewa SDK for PHP** is developed and maintained by [remotemerge] and the community, simplifying the integration of the eSewa payment service into PHP code. For more details, refer to the [eSewa Documentation] website.
## Getting Started
1. **Sign up for eSewa** – Before you begin, you need to sign up and retrieve your credentials from [eSewa].
2. **Minimum requirements** – To run the SDK, your system will need to meet the minimum requirements, including having **PHP >= 8.1**. We highly recommend having it compiled with the cURL extension and cURL compiled with a TLS backend (e.g., NSS or OpenSSL).
## Installation
**Install the SDK** – Using Composer is the recommended way to install the eSewa SDK for PHP. The SDK is available via Packagist under the [`remotemerge/esewa-php-sdk`][install-package] package.
```
composer require remotemerge/esewa-php-sdk
```
## Getting Help
Bugs and feature requests are tracked using GitHub issues, and prioritization is given to addressing them as soon as possible.
* For account and payment related concerns, please contact [eSewa] directly by calling or emailing them.
* If a bug is identified, please [open an issue](https://github.com/remotemerge/esewa-php-sdk/issues/new) on GitHub.
* For assistance with integrating eSewa into your application, feel free to reach out to the support team.
## Quick Examples
### Create an eSewa client
```php
// Init composer autoloader.
require dirname(__DIR__) . '/vendor/autoload.php';
use RemoteMerge\Esewa\Client;
// Set success and failure callback URLs.
$successUrl = 'https://example.com/success.php';
$failureUrl = 'https://example.com/failed.php';
// Initialize eSewa client for development.
$esewa = new Client([
'merchant_code' => 'EPAYTEST',
'success_url' => $successUrl,
'failure_url' => $failureUrl,
]);
// Initialize eSewa client for production.
$esewa = new Client([
'merchant_code' => 'b4e...e8c753...2c6e8b',
'success_url' => $successUrl,
'failure_url' => $failureUrl,
]);
```
Here `b4e...e8c753...2c6e8b` is merchant code retrieved from eSewa.
### Make Payment
When the user initiates the payment process, the package redirects the user to an eSewa site for payment processing. The
eSewa system will redirect the user to your specified success URL if the payment is successful and to the failure URL if
the payment fails.
```php
$esewa->payment('P101W201', 100, 15, 80, 50);
```
The method accepts five parameters.
```text
payment(string $pid, float $amt, float $txAmt = 0, float $psc = 0, float $pdc = 0)
```
1. `pid` A unique ID of product or item or ticket etc.
2. `amt` Amount of product or item or ticket etc
3. `txAmt` Tax amount on product or item or ticket etc. Pass `0` if Tax/VAT is not applicable.
4. `psc` The service charge (if applicable); default to `0`.
5. `pdc` The delivery charge (if applicable); default to `0`.
### OTP for Payment
When using the eSewa payment gateway in production mode, an OTP (One-Time Password) code is sent to the customer's mobile number to verify the transaction. In development mode, the OTP code is a fixed six-digit number, `123456`, for testing purposes.
### Verify Payment
The verification process identifies potentially fraudulent transactions and checks them against data such as transaction
amount and other parameters.
```php
$status = $esewa->verifyPayment('R101', 'P101W201', 245);
if ($status) {
// Verification successful.
}
```
The method accepts three parameters.
```text
verifyPayment(string $refId, string $oid, float $tAmt)
```
1. `refId` A unique payment reference code generated by eSewa.
2. `oid` Product ID used on payment request.
3. `tAmt` Total payment amount (including Tax/VAT and other charges.)
**Note:** You can extract `refId` from the success response url parameter.
## Contribution
The contributions of the Open Source community are highly valued and appreciated. To ensure a smooth and efficient process, please adhere to the following guidelines when submitting code:
- Ensure that the code adheres to [PER Coding Style 2.0] standards.
- All submitted code must pass relevant tests.
- Proper documentation and clean code practices are essential.
- Please make pull requests to the `main` branch.
Thank you for your support and contributions. Looking forward to reviewing your code.
[eSewa]: https://esewa.com.np
[remotemerge]: https://github.com/remotemerge
[eSewa Documentation]: https://developer.esewa.com.np
[install-package]: https://packagist.org/packages/remotemerge/esewa-php-sdk
[PER Coding Style 2.0]: https://www.php-fig.org/per/coding-style/