Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Braintree Payments processing for Mezzanine/Cartridge

Project description


Braintree Payments processing for Mezzanine/Cartridge. Supports Django 1.11.x and Cartridge 0.13 or 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 ‘’, otherwise the cartridge_braintree template will not be selected.

  3. Set up the following settings in your or

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


    When DEBUG is True the Braintree Sandbox environment will be used, otherwise the Braintree Production environment is used.

    See also

  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:

          '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'

      A pre-selected country in the select field can be specified using settings.SHOP_DEFAULT_COUNTRY as an alpha2 code. By default the user is expected to choose their country (set to None).

      The country/countries (as alpha2 codes) listed in settings.SHOP_PRIMARY_COUNTRIES will show up at the top of the country selection fields, after the settings.SHOP_DEFAULT_COUNTRY if set.

    • 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 jquery.payment from stripe 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.


  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 for Braintree’s tutorial.

  6. Include cartridge_braintree.urls for shop/checkout in before Cartridge urls:

    urlpatterns += [
        # cartridge_braintree URLs.
        url("^shop/(?=checkout(/?)$)", include("cartridge_braintree.urls")),
        # Cartridge URLs.
        url("^shop/", include("")),
        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 in the form:


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

  8. Optionally add logging to your Django configuration if you want to have more details on transactions:

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
        'handlers': {
            'braintree_file': {
                'class': 'logging.FileHandler',
                'filename': '/path/to/django/braintree.log',
        'loggers': {
            'braintree_payment': {
                'handlers': ['braintree_file'],
                'level': 'DEBUG',

    See for all configuration options

    Log levels are as follows:
    • Client token creation: info
    • Transaction start: debug
    • Transaction complete: debug
    • Transaction fail: warning

    Confidential information is never output to the logger.


1.2.2 (2021-04-19)

  • Set minimum Django version to 1.11.29 and maximum version under 1.12 to fix security vulnerabilities.

1.2.1 (2019-12-28)

  • Upgrade to Django 1.11 and Cartridge 0.13.

1.1.0 (2016-10-21)

  • Add logging to payment process. [ianare]
  • Breaking change: Add SHOP_DEFAULT_COUNTRY setting and by default force the user to select a country (set to True for v1.0.0 behavior). [ianare]

1.0.0 (2016-07-08)

  • Breaking change: Simplify urls setup. [ryneeverett]

    When upgrading to 1.0.0 change cartridge_braintree urls in to:

    url("^shop/(?=checkout(/?)$)", include("cartridge_braintree.urls")),
  • Make it a stable release version as it’s already well tested.

  • Introduce semantic versioning.

  • Use zest.releaser for release.

1.0b17 (2016-04-17)

  • Upgrade jquery.payment.js to v1.3.3. [ryneeverett]

1.0b16 (2016-04-17)

  • Fix documentation bug. It should be BRAINTREE_MERCHANT_ID not BRAINTREE_MERCHANT in

1.0b16 (2016-04-17)

  • Fix documentation bug. It should be BRAINTREE_MERCHANT_ID not BRAINTREE_MERCHANT in

1.0b14 (2016-03-14)

  • Replace the payform jQuery plugin with jquery.payment from stripe. This fixes some bugs with card number and CCV formatting.

1.0b13 (2016-02-03)

  • Move static content to subfolder.
  • Clean up translation files.
  • Minor fixes and javascript optimizations.

1.0b10 (2016-01-30)

  • Overextents templates instead of overriding 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 API.
  • Refactor country support for billing/shipping inspired by django-countries. and using their translations of country names.
  • Add client site credit card validation and number formatting using the jQuery plugin from 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).

Download files

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

Files for cartridge-braintree, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size cartridge_braintree-1.2.2-py2.py3-none-any.whl (209.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size cartridge_braintree-1.2.2.tar.gz (129.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page