eSewa Python SDK
A Python package to integrate with eSewa payment gateway, enabling you to initiate payments and check transaction status easily.
Features
- Initiate payment requests to eSewa
- Verify payment transaction status
- Generate unique transaction IDs
- Simple and easy-to-use API
- Designed to work well with Django/DRF and any Python web framework
Installation
pip install esewa
Configuration
Make sure to set your eSewa credentials and URLs correctly when calling the functions.
-
secret — Your eSewa secret key
-
success_url — URL eSewa redirects after successful payment
-
failure_url — URL eSewa redirects after failed payment
-
esewa_payment_url — eSewa payment endpoint (testing or production)
-
status_check_url — eSewa transaction status check endpoint
Integration with Django REST Framework
You can easily integrate this package within Django views or DRF viewsets to handle payment requests and status checks.
- Create a model to store transaction info
from django.db import models
from products.models import Product
class Transaction(models.Model):
STATUS_CHOICES = [
("PENDING", "Pending"),
("COMPLETE", "Complete"),
("FAILED", "Failed"),
("REFUNDED", "Refunded"),
]
product = models.ForeignKey(Product, on_delete=models.CASCADE, related_name="transactions")
transaction_uuid = models.CharField(max_length=255, unique=True)
amount = models.FloatField()
status = models.CharField(max_length=20, choices=STATUS_CHOICES, default="PENDING")
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
def __str__(self):
return f"{self.transaction_uuid} - {self.status}"
- Create Serializers
from rest_framework import serializers
from .models import Transaction
from products.models import Product
class ProductSerializer(serializers.ModelSerializer):
class Meta:
model = Product
fields = ['id', 'name', 'price', 'description']
class TransactionSerializer(serializers.ModelSerializer):
product = ProductSerializer(read_only=True)
product_id = serializers.PrimaryKeyRelatedField(
queryset=Product.objects.all(), source='product', write_only=True
)
class Meta:
model = Transaction
fields = ['id', 'transaction_uuid', 'amount', 'status', 'created_at', 'updated_at', 'product', 'product_id']
- Create Views to handle Esewa transactions
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from .models import Transaction
from .serializers import TransactionSerializer
from products.models import Product
from esewa import esewa_payment_gateway, esewa_check_status, generate_unique_id, base64_decode
class EsewaInitiatePaymentView(APIView):
def post(self, request):
try:
product = Product.objects.get(id=request.data["product_id"])
transaction_uuid = generate_unique_id()
esewa_response = esewa_payment_gateway(
amount=product.price,
product_delivery_charge=0,
product_service_charge=0,
tax_amount=0,
transaction_uuid=transaction_uuid,
product_code="your_product_code", # Replace with your actual product code
secret="your_secret", # Replace with your actual secret
success_url="your_success_url", # Replace with your actual success URL
failure_url="your_failure_url", # Replace with your actual failure URL
esewa_payment_url="your_payment_url" # Replace with your actual payment URL
)
transaction = Transaction.objects.create(
product=product,
transaction_uuid=transaction_uuid,
amount=product.price,
status="PENDING"
)
return Response({
"transaction": TransactionSerializer(transaction).data,
"payment_url": esewa_response.get("payment_url"),
"status": esewa_response.get("status"),
"message": esewa_response.get("message"),
})
except Product.DoesNotExist:
return Response({"error": "Invalid product ID"}, status=status.HTTP_404_NOT_FOUND)
except Exception as e:
return Response({"error": str(e)}, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
class EsewaStatusCheckView(APIView):
def post(self, request):
base64_data = request.data.get("data")
if not base64_data:
return Response({"error": "data is required"}, status=status.HTTP_400_BAD_REQUEST)
try:
decoded_data = base64_decode(base64_data)
transaction_uuid = decoded_data.get("transaction_uuid")
transaction = (
Transaction.objects
.filter(transaction_uuid=transaction_uuid)
.first()
)
if not transaction:
return Response({"error": "Transaction not found"}, status=status.HTTP_404_NOT_FOUND)
status_response = esewa_check_status(
total_amount=transaction.amount,
transaction_uuid=transaction.transaction_uuid,
product_code="EPAYTEST",
status_check_url="https://rc.esewa.com.np/api/epay/transaction/status/"
)
if status_response.get("status") == "SUCCESS":
transaction.status = "COMPLETED"
else:
transaction.status = status_response.get("status", "FAILED")
return Response(TransactionSerializer(transaction).data)
except Transaction.DoesNotExist:
return Response({"error": "No transaction found for this product"}, status=status.HTTP_404_NOT_FOUND)
except Exception as e:
return Response({"error": str(e)}, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
If you want to contribute to this project, feel free to submit a pull request or open an issue for discussion.
Contact
For any questions or issues, please open an issue on the GitHub repository.
Metadata
Release files for esewa 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| esewa-0.2.1.tar.gz | 8.8 kB | Without provenance | Details for esewa-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| esewa-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for esewa-0.2.1-py3-none-any.whl |
Total release size: 16.3 kB
Release files / esewa-0.2.1.tar.gz
| Download URL | esewa-0.2.1.tar.gz |
|---|---|
| Size | 8.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c991d59e66e6d7994e1199c2632761cb947ffeb165c4ada8cbfe689a098d2d2
|
|
BLAKE2b-256 checksum How to use checksums |
819e754a7ae0ec893161e7ed318505e7ef55e585a524eaa57e8cd80921a7d71d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
Release files / esewa-0.2.1-py3-none-any.whl
| Download URL | esewa-0.2.1-py3-none-any.whl |
|---|---|
| Size | 7.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
341dddf8404e13402e1b724fc3d117a7b768865a4dbbf4f265c481c07d6b418e
|
|
BLAKE2b-256 checksum How to use checksums |
12ed057a2c9323551c56a22debd5ff45c22a49a5474f82a6f530f09731c9fe3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
Security for esewa 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.