First steps into a payment provider API

doc/development/api/index.rst

@@ -8,3 +8,4 @@ Contents:
 
    plugins
    restriction
+   payment

doc/development/api/plugins.rst

@@ -57,5 +57,12 @@ example, taken from the time restriction module (see next chapter) as a template
    You have to implement a ``PretixPluginMeta`` class like in the example to make your
    plugin available to the users.
 
+Currently, the ``PluginType`` enum has the following values defined:
+
+* ``RESTRICTION``
+* ``PAYMENT``
+
+The next pages provide details on their usage.
+
 .. _signal dispatcher: https://docs.djangoproject.com/en/1.7/topics/signals/
 .. _namespace packages: http://legacy.python.org/dev/peps/pep-0420/

src/pretix/base/payment.py

@@ -0,0 +1,10 @@
+class BasePaymentProvider:
+    """
+    This is the base class for all payment providers.
+    """
+
+    def get_identifier(self) -> str:
+        """
+        Return a unique identifier for this payment provider
+        """
+        raise NotImplementedError()

src/pretix/base/plugins.py

@@ -8,6 +8,7 @@ from django.apps import apps
 
 class PluginType(Enum):
     RESTRICTION = 1
+    PAYMENT = 2
 
 
 def get_all_plugins() -> "List[class]":

src/pretix/base/signals.py

@@ -51,3 +51,11 @@ return a positive result (see plugin API documentation for details).
 determine_availability = EventPluginSignal(
     providing_args=["item", "variations", "context", "cache"]
 )
+
+"""
+This signal is sent out to get all known payment providers. Receivers should return a
+subclass of pretix.base.payment.BasePaymentProvider
+"""
+register_payment_providers = EventPluginSignal(
+    providing_args=[]
+)

src/pretix/plugins/banktransfer/__init__.py

@@ -0,0 +1,22 @@
+from django.apps import AppConfig
+from django.utils.translation import ugettext_lazy as _
+from pretix.base.plugins import PluginType
+
+
+class BankTransferApp(AppConfig):
+    name = 'pretix.plugins.banktransfer'
+    verbose_name = _("Bank transfer")
+
+    class PretixPluginMeta:
+        type = PluginType.PAYMENT
+        name = _("Bank transfer")
+        author = _("the pretix team")
+        version = '1.0.0'
+        description = _("This plugin allows you to receive payments " +
+                        "via bank transfer ")
+
+    def ready(self):
+        from . import signals  # NOQA
+
+
+default_app_config = 'pretix.plugins.banktransfer.BankTransferApp'

src/pretix/plugins/banktransfer/payment.py

@@ -0,0 +1,5 @@
+from pretix.base.payment import BasePaymentProvider
+
+
+class BankTransfer(BasePaymentProvider):
+    pass

src/pretix/plugins/banktransfer/signals.py

@@ -0,0 +1,10 @@
+from django.dispatch import receiver
+
+from pretix.base.signals import register_payment_providers
+
+from .payment import BankTransfer
+
+
+@receiver(register_payment_providers)
+def register_payment_provider(sender, **kwargs):
+    return BankTransfer

src/pretix/settings.py

@@ -46,6 +46,7 @@ INSTALLED_APPS = (
     'djangoformsetjs',
     'pretix.plugins.testdummy',
     'pretix.plugins.timerestriction',
+    'pretix.plugins.banktransfer',
 )
 
 MIDDLEWARE_CLASSES = (