README.rst

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_pesapal

1. Add django_pesapal to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = (
       ...
       'django_pesapal',
   )
   

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

   url(r'^payments/', include('django_pesapal.urls')),
   

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_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]',
           }
   
           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.

Configuration

Setting	Default Value
PESAPAL_DEMO	True
PESAPAL_CONSUMER_KEY	''
PESAPAL_CONSUMER_SECRET	''
PESAPAL_IFRAME_LINK (if PESAPAL_DEMO=True)	'http://demo.pesapal.com/api/PostPesapalDirectOrderV4'
PESAPAL_IFRAME_LINK (if PESAPAL_DEMO=False)	'https://www.pesapal.com/api/PostPesapalDirectOrderV4'
PESAPAL_QUERY_STATUS_LINK (Demo Mode=True)	'http://demo.pesapal.com/API/QueryPaymentDetails'
PESAPAL_QUERY_STATUS_LINK (Demo Mode=False)	'https://www.pesapal.com/API/QueryPaymentDetails'
PESAPAL_OAUTH_CALLBACK_URL	'transaction_completed'
PESAPAL_OAUTH_SIGNATURE_METHOD	'SignatureMethod_HMAC_SHA1'
PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL	'/'
PESAPAL_TRANSACTION_FAILED_REDIRECT_URL	''
PESAPAL_REDIRECT_WITH_REFERENCE	True
PESAPAL_TRANSACTION_MODEL	'django_pesapal.Transaction'