Skip to main content

Braintree Payments processing for Mezzanine/Cartridge

Project description

cartridge_braintree
===================

Braintree Payments processing for Mezzanine/Cartridge.
Supports Cartridge 0.11 and newer.

Instructions for use
--------------------

1. Install cartridge_braintree::

pip install cartridge_braintree

If you need the correct sorting of not ASCII country names use::

pip install cartridge_braintree[countries_utf8_sorting]

This will add 'pyuca' to the requirements.

2. Add 'cartridge_braintree' to your ``INSTALLED_APPS``. List it higher than
'cartridge.shop', otherwise the cartridge_braintree template will
not be selected.

3. Set up the following settings in your ``settings.py`` or ``local_settings.py``::

BRAINTREE_MERCHANT = <your merchant ID>
BRAINTREE_PUBLIC_KEY = <your public key>
BRAINTREE_PRIVATE_KEY = <your private key>

.. Note::
When ``DEBUG`` is ``True`` the *Braintree Sandbox environment* will be
used, otherwise the *Braintree Production environment* is used.

See also
https://articles.braintreepayments.com/control-panel/important-gateway-credentials

4. cartridge_braintree uses a modified checkout form, which does the following:

- Changes the shipping and billing country fields to a Select
widget. This ensures that the country selected can be converted to
a valid code for Braintree's payment processing.
The supported countries can be set in ``settings.SHOP_SUPPORTED_COUNTRIES``,
which is a list of alpha2 country codes and/or tuples in the form
(alpha2, country_name).

For example if you want to select the countries in the EU area use::

SHOP_SUPPORTED_COUNTRIES = [
'AL', 'AT', 'BA', 'BE', 'BG', 'CH', 'CY', 'DE', 'DK', 'EE', 'ES',
'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IS', 'IT', 'LT', 'LV',
'MK', 'MT', 'NL', 'NO', 'PL', 'PT', 'RO', 'RS', 'SE', 'SI'
]

The country/countries (as alpha2 codes) listed in
``settings.SHOP_PRIMARY_COUNTRIES`` will show up at the top of the
country selection fields.

- Credit Card number and CCV fields are rendered using the
``NoNameTextInput`` widget so that the data is not submitted to the
server. Javascript processes these fields to create a
``payment_method_nonce``, which is then stored in a hidden form
element.

- Uses `payform <https://github.com/jondavidjohn/payform>`_ for client-side
validation of the payment form and submits the errors in the hidden
``braintree_errors`` field to the server to handle them as Django errors.

See
https://developers.braintreepayments.com/guides/transactions/python

5. Set the payment handler to be the Braintree payment handler::

SHOP_HANDLER_PAYMENT = 'cartridge_braintree.braintree_payment.payment_handler'

If you are overriding the templates in your own apps, then be sure to
include the relevant ``braintreejs.html`` template.

See https://www.braintreepayments.com/docs/python/guide/getting_paid
for Braintree's tutorial.

6. Include ``cartridge_braintree.urls`` for ``shop/checkout`` in ``urls.py``
before Cartridge urls and define the ``_slash`` variable::

_slash = "/" if settings.APPEND_SLASH else ""

urlpatterns += [

# cartridge_braintree URLs.
url("^shop/checkout%s" % _slash, include("cartridge_braintree.urls")),

# Cartridge URLs.
url("^shop/", include("cartridge.shop.urls")),
url("^account/orders/$", order_history, name="shop_order_history"),

7. If you want to use PayPal payments with Braintree activate them in
the Admin Site Settings and set the currency to use with PayPal.

Alternatively you can set them in ``settings.py`` in the form::

BRAINTREE_PAYPAL_ACTIVATE = True
BRAINTREE_PAYPAL_CURRENCY = "EUR"

In this case the settings will not be shown in the Admin.

CHANGES
=======

1.0b10 (2016-01-30)
------------------

- Overextents templates instead of overwriting them.
- Show Card payment form when Django returns errors.
- Add placeholders for card number and CCV
and trigger numeric keyboard on iPhone.
- Add dependency on Cartridge 0.11.
Drop support for older Cartridge versions.
- Minor fixes.

1.0b8 (2016-01-25)
------------------

- Upgrade to Cartridge 0.11.
- Clean up the template directory.

1.0b4 (2016-01-21)
------------------

This is an entire rewrite release of the whole app by Henri Hulski.

- Rewriting the app to match the new Braintree v.zero API.
- Refactor country support for billing/shipping inspired by
`django-countries <https://github.com/SmileyChris/django-countries>`_.
and using their translations of country names.
- Add client site credit card validation and number formatting using the
jQuery plugin from `payform <https://github.com/jondavidjohn/payform>`_.
- Include PayPal payments.
- Add country names translations from django-countries.
Full translation of the app for German, French and Polish.
- Change license from MIT to BSD.
- Make it a full PyPI package.

Initial release (2013-07-28)
----------------------------

Initial release by Danny Sag (molokov).

CREDITS
=======

* Danny Sag (molokov): Initial author

* Henri Hulski:

- Rewriting the app to match the new v.zero API.
- Add client-side card validation.
- Refactor country support.
- Include PayPal payments.
- Make it a full PyPI package.

* Jonathan D. Johnson:

Cartridge_braintree is using the jQuery plugin from payform_
for client-side credit card validation and number formatting.

.. _payform: https://github.com/jondavidjohn/payform

* Chris Beaven:

The country selection is based on django-countries_.
Cartridge_braintree uses also the translations of country names
from django-countries.

.. _django-countries: https://github.com/SmileyChris/django-countries

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cartridge_braintree-1.0b10.tar.gz (293.4 kB view hashes)

Uploaded Source

Built Distribution

cartridge_braintree-1.0b10-py2.py3-none-any.whl (374.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page