django-pesapal

A django port of pesapal payment gateway

Documentation

The full documentation is at https://django-pesapal.readthedocs.org.

Quickstart

Install django-pesapal:

pip install django-pesapal

Then use it in a project:

import django_pesapalv3

1. Add django_pesapalv3 to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = (
       ...
       'django.contrib.sites',  # always add - needed by the app
       'django_pesapal',   # always add
       'django_pesapalv3',  # add this if using v3 api
   )
   

2. Include the django_pesapal URLconf in your project urls.py like this:

   path('payments/v3/', include('django_pesapalv3.urls')),
   # path('payments/', include('django_pesapal.urls')),  # use this if using v1/classic api
   

3. You can set your own return url by adding this to settings.py:

   PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL = 'app_name:url_name'  # this needs to be a reversible
   

4. Run python manage.py migrate to create the models.

5. Create a method that receives payment details and returns the pesapal iframe url:

   from django_pesapalv3.views import PaymentRequestMixin
   
   class PaymentView(PaymentRequestMixin, TemplateView):
       template_name = "django_pesapal/payment.html" # you can replace with your own template
   
       def get_context_data(self, **kwargs):
           ctx = super(PaymentView, self).get_context_data(**kwargs)
           ctx["pesapal_url"] = self.get_pesapal_payment_iframe()
           return ctx
   
       def get_pesapal_payment_iframe(self):
           '''
           Authenticates with pesapal to get the payment iframe src
           '''
           ipn = self.get_default_ipn()  # you can replace this with your own ipn registration method
   
           order_info = {
               "id": self.request.GET.get("id", uuid.uuid4().hex),  # replace this with a valid merchant id
               "currency": "KES",
               "amount": 10,
               "description": "Payment for X",
               "callback_url": self.build_url(
                   reverse("django_pesapalv3:transaction_completed")
               ),
               "notification_id": ipn,
               "billing_address": {
                   "first_name": "John",
                   "last_name": "Doe",
                   "email": "[email protected]",
               },
           }
           req = self.submit_order_request(**order_info)
           return req["redirect_url"]
   

6. In case you are using v1/classic api, use this instead:

   from django_pesapal.views import PaymentRequestMixin
   
   class PaymentView(PaymentRequestMixin, TemplateView):
   
       def get_pesapal_payment_iframe(self):
           '''
           Authenticates with pesapal to get the payment iframe src
           '''
           order_info = {
               'first_name': 'Some',
               'last_name': 'User',
               'amount': 100,
               'description': 'Payment for X',
               'reference': 2,  # some object id
               'email': '[email protected]',
           }
   
           return self.get_payment_url(**order_info)
   

7. Once payment has been processed, you will be redirected to an intermediate screen where the user can finish ordering. Clicking the "Check status" button will check the payment status to ensure that the payment was successful and then redirects the user to PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL.

Configuration

Setting	Default Value
PESAPAL_DEMO	True
PESAPAL_CONSUMER_KEY	''
PESAPAL_CONSUMER_SECRET	''
PESAPAL_OAUTH_CALLBACK_URL	'transaction_completed'
PESAPAL_OAUTH_SIGNATURE_METHOD	'SignatureMethod_HMAC_SHA1'
PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL	'<app:reversible_url>'
PESAPAL_TRANSACTION_FAILED_REDIRECT_URL	PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL
PESAPAL_REDIRECT_WITH_REFERENCE	True
PESAPAL_TRANSACTION_MODEL	'django_pesapal.Transaction'
PESAPAL_IPN_URL (for v3)	'django_pesapalv3:transaction_ipn'
PESAPAL_CALLBACK_URL (for v3)	'django_pesapalv3:transaction_completed'