README.rst

django-khalti

django-khalti is a Django app based on djangorestframework to conduct server based payment verification of khalti payment gateway. For each payment,it can verify and return status of payment through transaction token and paid amount.

Detailed documentation is in the "docs" directory.

Quick start

1. Intall the django-khalti and django rest framework like this:

   pip install djangorestframework
   pip install django-khalti
   

2. Add "django-khalti" and "djangorestframework "to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...
       'rest_framework',
       'khalti',
   ]
   

3. Include the django-khalti URLconf in your project urls.py like this:

   path('khalti/', include('khalti.urls')),
   

4. Add Khalti Merchant API key and Verify URL in your settings.py

   KHALTI_SECRET_KEY = "<your api key>"
   KHALTI_VERIFY_URL = "https://khalti.com/api/v2/payment/verify/"
   

5.Test your endpoints like this:

POST: /khalti/verifypayment/
body:{
    'token':<transaction token>,
    'amount':<transaction amount>
}

6.You will get responses like this:

On Success:
    {
        'status':True,
        'details':{
                      "idx": "8xmeJnNXfoVjCvGcZiiGe7",
                      "type": {
                        "idx": "e476BL6jt9kgagEmsakyTL",
                        "name": "Wallet payment"
                      },
                      "state": {
                        "idx": "DhvMj9hdRufLqkP8ZY4d8g",
                        "name": "Completed",
                        "template": "is complete"
                      },
                      "amount": 1000,
                      "fee_amount": 30,
                      "refunded": false,
                      "created_on": "2018-06-20T14:48:08.867125+05:45",
                      "ebanker": null,
                      "user": {
                        "idx": "cCaPkRPQGn5D8StkiqqMJg",
                        "name": "Test User",
                        "mobile": "98XXXXXXX9"
                      },
                      "merchant": {
                        "idx": "UM75Gm2gWmZvA4TPwkwZye",
                        "name": "Test Merchant",
                        "mobile": "[email protected]"
                      }
                }
    }

On Error:
    {
        'status':False,
        'details':{'token': ['Invalid token.']}
    }