https://github.com/sudiptpa/esewa

Integrate eSewa payment gateway for online payments. A php library to comsume eSewa payment gateway API, built on top of Omnipay Payment processing library. Read the blog post to follow the step by step guide on how to integrate esewa with Laravel PHP framework.
https://github.com/sudiptpa/esewa

composer esewa esewa-api esewa-driver esewa-epay esewa-gateway esewa-nepal esewa-pnp gateway omnipay payment payment-gateway payments php

Last synced: 6 months ago
JSON representation

Integrate eSewa payment gateway for online payments. A php library to comsume eSewa payment gateway API, built on top of Omnipay Payment processing library. Read the blog post to follow the step by step guide on how to integrate esewa with Laravel PHP framework.

• Host: GitHub
• URL: https://github.com/sudiptpa/esewa
• Owner: sudiptpa
• License: mit
• Created: 2016-12-05T03:55:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-03-08T10:28:05.000Z (over 1 year ago)
• Last Synced: 2026-01-11T12:41:16.020Z (6 months ago)
• Topics: composer, esewa, esewa-api, esewa-driver, esewa-epay, esewa-gateway, esewa-nepal, esewa-pnp, gateway, omnipay, payment, payment-gateway, payments, php
• Language: PHP
• Homepage: https://sujipthapa.com/blog/esewa-payment-gateway-integration-with-laravel
• Size: 68.4 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Omnipay: eSewa

**eSewa driver for the Omnipay PHP payment processing library**

[Omnipay](https://github.com/thephpleague/omnipay) is a framework agnostic, multi-gateway payment

processing library for PHP. This package implements eSewa support for Omnipay.

[![StyleCI](https://github.styleci.io/repos/75586885/shield?branch=master&format=plastic)](https://github.styleci.io/repos/75586885)

[![Latest Stable Version](https://poser.pugx.org/sudiptpa/omnipay-esewa/v/stable)](https://packagist.org/packages/sudiptpa/omnipay-esewa)

[![Total Downloads](https://poser.pugx.org/sudiptpa/omnipay-esewa/downloads)](https://packagist.org/packages/sudiptpa/omnipay-esewa)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/sudiptpa/esewa/master/LICENSE)

## Installation

Omnipay is installed via [Composer](http://getcomposer.org/). To install, simply require `league/omnipay` and `sudiptpa/omnipay-esewa` with Composer:

```

composer require league/omnipay sudiptpa/omnipay-esewa

```

**Looking for ePay v1? Check [this documentation](./docs/README-v1.md) for installation instructions.**

## Basic Usage

### Purchase

```php

    use Omnipay\Omnipay;

    use Exception;

    $gateway = Omnipay::create('Esewa_Secure');

    $gateway->setMerchantCode('epay_payment');

    $gateway->setSecretKey('secret_key_provided_by_esewa');

    $gateway->setTestMode(true);

    try {

        $response = $gateway->purchase([

            'amount' => 100,

            'deliveryCharge' => 0,

            'serviceCharge' => 0,

            'taxAmount' => 0,

            'totalAmount' => 100,

            'productCode' => 'ABAC2098',

            'returnUrl' => 'https://merchant.com/payment/1/complete',

            'failedUrl' => 'https://merchant.com/payment/1/failed',

        ])->send();

        if ($response->isRedirect()) {

            $response->redirect();

        }

    } catch (Exception $e) {

        return $e->getMessage();

    }

```

After successful payment and redirect back to merchant site, you need to verify the payment response.

### Verify Payment

```php

    $gateway = Omnipay::create('Esewa_Secure');

    $gateway->setMerchantCode('epay_payment');

    $gateway->setSecretKey('secret_key_provided_by_esewa');

    $gateway->setTestMode(true);

    $payload = json_decode(base64_decode($_GET['data']), true);

    $signature = $gateway->generateSignature(generateSignature($payload));

    if ($signature === $payload['signature']) {

        // Verified

    } else {

        // Unverified

    }

```

You can also check the status of payment if no any response is received when redirected back to merchant's site.

### Check Status

```php

    $gateway = Omnipay::create('Esewa_Secure');

    $gateway->setMerchantCode('epay_payment');

    $gateway->setSecretKey('secret_key_provided_by_esewa');

    $gateway->setTestMode(true);

    $payload = [

        'totalAmount' => 100,

        'productCode' => 'ABAC2098',

    ];

    $response = $gateway->checkStatus($payload)->send();

    if ($response->isSuccessful()) {

        // Success

    }

```

## Working Example

Want to see working examples before integrating them into your project? View the examples **[here](https://github.com/pralhadstha/payment-gateways-examples)**

## Laravel Integration

Please follow the [eSewa Online Payment Gateway Integration](https://sujipthapa.com/blog/esewa-payment-gateway-integration-with-laravel) and follow step by step guidlines.

## Official Doc

Please follow the [Official Doc](https://developer.esewa.com.np) to understand about the parameters and their descriptions.

## Contributing

Contributions are **welcome** and will be fully **credited**.

Contributions can be made via a Pull Request on [Github](https://github.com/sudiptpa/esewa).

## Support

If you are having general issues with Omnipay Esewa, drop an email to sudiptpa@gmail.com for quick support.

If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/sudiptpa/esewa/issues),

or better yet, fork the library and submit a pull request.

## License

This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).