django-payfast 0.1.1

Payment form

payfast.forms.PayFastForm can be used to construct the html form. It is a helper form for html output and it shouldn’t perform any validation.

Pass all the fields to form ‘initial’ argument. Form also has an optional ‘user’ parameter: it is the User instance the order is purchased by. If ‘user’ is specified, ‘name_first’, ‘name_last’ and ‘email_address’ fields will be filled automatically if they are not passed with ‘initial’.

Example:

# views.py

from django.shortcuts import get_object_or_404
from django.views.generic.simple import direct_to_template
from django.contrib.auth.decorators import login_required

from payfast.forms import PayFastForm

@login_required
def pay_with_payfast(request, order_id):

    # Order model have to be defined by user, it is not a part
    # of django-payfast
    order = get_object_or_404(Order, pk = order_id)

    form = PayFastForm(initial={
        # required params:
        'amount': order.total,
        'item_name': 'the name of the item being charged for',

        # optional params:
        # 'return_url' : 'http://my-site.com/orders/payfast/return/',
        # 'cancel_url' : 'http://my-site.com/orders/payfast/cancel/'
        # ... etc.
    }, user=order.user)

    return direct_to_template(request, 'pay_with_payfast.html', {'form': form})

Please refer to PayFast docs (http://www.payfast.co.za/c/std/website-payments-variables) for more options. ‘merchant_id’, ‘merchant_key’, ‘notify_url’ and ‘signature’ params are handled automatically.

The template:

{% extends 'base.html' %}

{% block content %}
    <form action="{{ form.target }}" method="POST">
        <p>{{ form.as_p }}</p>
        <p><input type="submit" value="Buy Now"></p>
    </form>
{% endblock %}

The {{ form.as_p }} output will be a number of <input type='hidden'> tags.

PayFastForm has a ‘target’ attribute with PayFast server URL.

Please note that it’s up to you to implement the order processing logic. Order handling should be performed in payfast.signals.data signal handler.

payfast.signals.notify signal

When PayFast posts data to the Notify URL payfast.signals.notify signal is sent. This signal won’t be sent for suspicious data (when request is coming from untrusted ip, form validation fails or the payment is duplicate).

Signal subscribers will get an ‘order’ argument with PayFastOrder instance.

Example:

import payfast.signals

def data_received(sender, **kwargs):
    payfast_order = kwargs['order']

    if payfast_order.payment_status == 'COMPLETE':

        # The order is paid (merchant_id check and check for duplicate
        # payments is already handled by django-payfast)

        amount = payfast_order.amount
        # your business logic
        # ...
    else: # the order is not paid
        # your business logic
        # ...

payfast.signals.notify.connect(data_received)

urls.py

In order to get Notify URL up and running, include payfast.urls in your urls.py:

urlpatterns = patterns('',
    #...
    url(r'^payfast/', include('payfast.urls')),
    #...
)