Django Helpers

1. URL callback processor:

   # urls.py
   from django.urls import include, url
   
   urlpatterns = [
       url('^payments/', include('web_payments.urls'))]
   

2. Creating a Payment model by subclassing more sophisticated web_payments.django.models.BasePayment or web_payments.django.models.BasePaymentWithAddress:

   # mypaymentapp/models.py
   from decimal import Decimal
   
   from web_payments import PurchasedItem
   from web_payments.models import BasePayment
   
   class Payment(BasePayment):
   
       def get_failure_url(self):
           return 'http://example.com/failure/'
   
       def get_success_url(self):
           return 'http://example.com/success/'
   
       def get_purchased_items(self):
           # you'll probably want to retrieve these from an associated order
           yield PurchasedItem(name='The Hound of the Baskervilles', sku='BSKV',
                               quantity=9, price=Decimal(10), currency='USD')
   

   The get_purchased_items() method should return an iterable yielding instances of web_payments.PurchasedItem.

3. Get Payment object with payment.get_form() (full view example):

   # mypaymentapp/views.py
   from django.shortcuts import get_object_or_404, redirect
   from django.template.response import TemplateResponse
   from web_payments import RedirectNeeded
   from web_payments.django import get_payment_model
   
   def payment_details(request, payment_id):
       payment = get_object_or_404(get_payment_model(), id=payment_id)
       try:
           form = payment.get_form(data=request.POST or None)
       except RedirectNeeded as redirect_to:
           return redirect(redirect_to.args[0])
       return TemplateResponse(request, 'payment.html',
                               {'form': form, 'payment': payment})
   

   Note

   Please note that Payment.get_form() may raise a RedirectNeeded exception.

4. Configuration by settings.py:

   # settings.py
   from web_payments import ProviderVariant
   INSTALLED_APPS = [
       # ...
       'web_payments.django',
       ]
   
   PAYMENT_HOST = 'localhost:8000'
   PAYMENT_PROTOCOL = "https"
   PAYMENT_MODEL = 'mypaymentapp.Payment'
   # 'default' is used as extra["name"]
   PAYMENT_VARIANTS_API = {
       'default': ProviderVariant('web_payments_dummy.DummyProvider', {}, {"localized_name": "default", "icon": "icon.png"}),
       # or:
       'default2': ('web_payments_dummy.DummyProvider', {}, {"localized_name": "default", "icon": "icon.png"})
   }
   

   Variants are named pairs of payment providers, their configuration and extra information.

   Note

   Variant names may are used in URLs so it’s best to stick to ASCII and use extra for fancy naming

   Note

   PAYMENT_HOST can also be a callable object which takes a web_payments.ProviderVariant.