summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py4
-rw-r--r--doc/modules.rst33
2 files changed, 33 insertions, 4 deletions
diff --git a/doc/conf.py b/doc/conf.py
index fe8a138..8d825ff 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -43,9 +43,9 @@ copyright = u'2010-2013, Mirumee Software'
# built documents.
#
# The short X.Y version.
-version = '0.3'
+version = '0.4'
# The full version, including alpha/beta/rc tags.
-release = '0.3.2'
+release = '0.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/doc/modules.rst b/doc/modules.rst
index ca402a4..35ece11 100644
--- a/doc/modules.rst
+++ b/doc/modules.rst
@@ -118,7 +118,7 @@ To specify the `postback URL` at the Merchant Settings page use direct url to `p
E.g: ``https://example.com/payments/process/wallet``
-Paypal
+PayPal
------
.. class:: payments.paypal.PaypalProvider(client_id, secret[, endpoint='https://api.paypal.com'])
@@ -138,7 +138,7 @@ Example::
'secret': 'iseedeadpeople',
'endpoint': 'https://api.sandbox.paypal.com'})}
-.. class:: payments.paypal.PaypalCardProvider(client_id, secret, endpoint='https://api.paypal.com')
+.. class:: payments.paypal.PaypalCardProvider(client_id, secret[, endpoint='https://api.paypal.com'])
This backend implements payments using `PayPal.com <https://www.paypal.com/>`_ but the credit card data is collected by your site.
@@ -174,3 +174,32 @@ Example::
'encryption_key': '1234567890abcdef',
'endpoint': 'https://test.sagepay.com/Simulator/VSPFormGateway.asp'})}
+
+Stripe
+-------------
+
+.. class:: payments.stripe.StripeProvider(secret_key, public_key)
+
+ This backend implements payments using `Stripe <https://stripe.com/>`_.
+
+ :param secret_key: Secret key assigned by Stripe.
+ :param public_key: Public key assigned by Stripe.
+
+Example::
+
+ # use sandbox
+ PAYMENT_VARIANTS = {
+ 'stripe': ('payments.stripe.StripeProvider', {
+ 'secret_key': 'sk_test_123456',
+ 'public_key': 'pk_test_123456'})}
+
+This backend requires js files that should be added to the template using ``{{ form.media }}`` e.g:
+
+.. code-block:: html
+
+ <!-- templates/payment.html -->
+ <form action="{{ form.action }}" method="{{ form.method }}">
+ {{ form.as_p }}
+ <p><input type="submit" value="Proceed" /></p>
+ </form>
+ {{ form.media }}