Skip to main content

A django port of pesapal payment gateway

Project description Development Status

A django port of pesapal payment gateway


The full documentation is at


Install django-pesapal:

pip install django-pesapal

Then use it in a project:

import django_pesapal
  1. Add django_pesapal to your INSTALLED_APPS setting like this:

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

    url(r'^payments/', include('django_pesapal.urls')),
  3. You can set your own return url by adding this to

    PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL = 'app_name:url_name'  # this needs to be a reversible
  4. Run python migrate to create the models.

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

    from django_pesapal.views import PaymentRequestMixin
    class PaymentView(PaymentRequestMixin):
        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': '',
            iframe_src_url = self.get_payment_url(**order_info)
            return iframe_src_url
  6. Once payment has been processed, you will be redirected to an intermediate screen where the user can finish ordering. Clicking the “Finish Ordering” button will check the payment status to ensure that the payment was successful and then redirects the user to PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL.



Default Value
























1.3.2 (2022-01-21)

  • Support for Django 3.9

  • Update dependencies

  • Support Py38, Py39

  • Remove EOL py27

1.3.1 (2019-07-16)

  • Update dependencies

  • Support Py37

  • Remove EOL py34

1.3.0 (2018-09-29)

  • Support for Django 2.1

  • Support Py36

1.2.0 (2016-12-11)

  • Dropped support for Django 1.7

  • Fixes and Upgrades to support Django 1.8 - 1.10

  • Use Django’s UUIDField

1.1.0 (2016-05-03)

  • Support Django 1.9

  • Update payment_method field length from 16 to 24

  • Remove support for Py33. Support Py35

1.0.1 (2015-11-21)

  • Fix querydict bug

1.0.0 (2015-11-11)

  • Support Django 1.8

  • Support Py33 and Py34

  • Return proper IPN response

0.3.4 (2015-08-12)

  • Restructure flow to better support IPN processing

0.3.3 (2015-06-29)

  • Setup build had not packaged the templates

0.3.2 (2015-06-13)

  • Fix documentation formatting issues

0.3.1 (2015-06-13)

  • Allow specifying own transaction model

  • Pass all transaction info when redirecting

  • Update intermediate template

0.3 (2015-06-12)

  • Introduce intermediate payment processing screen

  • Update Django version to 1.7+

  • Add support to receive and process IPN

  • Save all details about the transaction and status

0.2.1 (2015-04-03)

  • Added test sandbox

  • Updated Django version

  • Updated django-uuidfield

0.2 (2015-03-17)

  • Support anonymous checkouts

  • Add support for getting payment status

  • Major structural refactoring. Use mixins

  • Use Mixins and XML Builder

0.1.5 (2014-09-25)

  • Pin dependencies to specific versions

  • Update how imports should be done

  • Remove imports from

0.1.4 (2014-09-23)

  • Fix import bug. Tests for projects using this fail in Shippable

  • Set max Django version to 1.7

0.1.3 (2014-07-18)

  • Packaging for PyPi

0.1.2 (2014-06-30)

  • Fix import bug in

  • Fix how callback url is constructed

  • Fix: Live URL uses https

0.1.1 (2014-06-30)

  • Refactor handling of redirect urls. Model validation of transaction and merchant reference

  • Rename settings to conf. Set default oauth redirect url

  • Add django-uuidfield to dependencies

0.1.0 (2014-06-30)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-pesapal-1.3.2.tar.gz (14.9 kB view hashes)

Uploaded source

Built Distribution

django_pesapal-1.3.2-py2.py3-none-any.whl (14.8 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page