KNPay Plugin

Connects KNPay into your project

Quick start

Installation

1. Using pip:

$ pip install knpay_plugin

2. Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'knpay_plugin.apps.KnpayPluginConfig',
    ...
)

3. Add KNPay Plugin's URL patterns:

from knpay_plugin import urls as knpay_plugin_urls


urlpatterns = [
    ...
    url(r'^payment/', include(knpay_plugin_urls)),
    ...
]

4. Sync database (./manage.py migrate).

Demo

Let's say we have a django app called checkout and the below files.

checkout/views.py

from django.views.generic import FormView
from knpay_plugin.views import CreatePaymentMixin, BaseCompletedView
from knpay_plugin.forms import PaymentForm


class CreatePaymentView(CreatePaymentMixin, FormView):
    template_name = 'knpay_plugin/payment_method.html'

    def get_initial(self):
        initial = super(CreatePaymentView, self).get_initial()
        initial.update({
            'amount': '123.000',
            # and rest of the model fields can be filled here
        })
        return initial


class CompletedView(BaseCompletedView):
    template_name = 'checkout/payment_details.html'

    def handle_successful_payment(self, request, *args, **kwargs):
        # this method will be called only once
        # place order
        # add success message
        # return to get method
        return self.get(request, *args, **kwargs)

    def handle_canceled_payment(self, request, *args, **kwargs):
        # this method will be called only once
        # payment failed to various reasons
        # add error message
        # return to get
        return self.get(request, *args, **kwargs)

checkout/urls.py

from knpay_plugin.conf import config

urlpatterns = [
    url(r'^choose-method/$', views.CreatePaymentView.as_view(), name='choose_method'),
    url(r'^completed/%s/$' % config.COMPLETE_VIEWS_REGEX,
        views.CompletedView.as_view(), name='complete'),
    # ...
]

settings.py

KNPAY_REDIRECTED_VIEW_NAME = 'checkout:complete'

knpay_plugin/payment_method.html

{% load knpay_tags %}

<form id="payment-form" action="{% url 'checkout:choose_method' %}" method="post">
    {% csrf_token %}

    {% show_gateway_choices %}

    <button type="submit" id="submit-payment-form">Submit</button>
</form>

checkout/payment_details.html

{% load knpay_tags %}

    <h2>{% trans 'Status' %}: {{ object.get_status_display }}</h2>
    {% prepare_payload object as payload %}
    <ul>
        {% for key, value in payload.iteritems %}
            <li>{{ key }}: {{ value }}</li>
        {% endfor %}
    </ul>

API

If PaymentForm and CreatePaymentMixin is a hassle for your needs, you can use a function to create the payment url.

from knpay_plugin.api import create_payment_url

result, created = create_payment_url('123.000', gateway_code='knet')
if created:
    # result is http://knpay3.mykuwaitnet.net/gw/dispatch/2kbEIQo1Z2hDll8/
    return JsonResponse(dict(redirect_url=result), status=200)
else:
    return JsonResponse(dict(errors=result), status=400)

result, created = create_payment_url('123.000')
# result is {'gateway_code': 'This field is required.'}

Still, creating direct payment urls can be controlled even more

result, created = create_payment_url('12',
                                     gateway_code='knet',
                                     request=None,
                                     currency_code='USD',
                                     extra={'booking_id': 'foo_bar'},
                                     language='ar',
                                     customer_email='foo@example.com',
                                     customer_address_country='QA'
                                     )

Additional information

Gateway choices display

Template which resides in knpay_plugin/gateway_choices.html must be overriden in your installation in order to reflect the style you need.

CONFIG

Prepend KNPAY_ for any variable which will be overriden.