The Braintree Python library provides integration access to the Braintree Gateway.

The Payment Card Industry (PCI) Council has mandated that early versions of TLS be retired from service. All organizations that handle credit card information are required to comply with this standard. As part of this obligation, Braintree has updated its services to require TLS 1.2 for all HTTPS connections. Braintrees require HTTP/1.1 for all connections. Please see our technical documentation for more information.

• requests

The Braintree Python SDK is tested against Python versions 3.5.3 and 3.12.0.

The Python core development community has released End-of-Life branches for Python versions 2.7 - 3.4, and are no longer receiving security updates. As a result, Braintree no longer supports these versions of Python.

⚠️ The SSL certificates for Python SDK versions older than 3.40.0 are set to expire by March 30, 2026. If you do not update your SDK to the latest version with the updated certificates by March 30, 2026, 100% of your impacted traffic will fail

Braintree employs a deprecation policy for our SDKs. For more information on the statuses of an SDK check our developer docs.

• Official documentation

Updating from an Inactive, Deprecated, or Unsupported version of this SDK? Check our Migration Guide for tips.

import braintree

gateway = braintree.BraintreeGateway(
    braintree.Configuration(
        environment=braintree.Environment.Sandbox,
        merchant_id="your_merchant_id",
        public_key="your_public_key",
        private_key="your_private_key",
    )
)

result = gateway.transaction.sale({
    "amount": "1000.00",
    "payment_method_nonce": nonce_from_the_client,
    "options": {
        "submit_for_settlement": True
    }
})

if result.is_success:
    print("success!: " + result.transaction.id)
elif result.transaction:
    print("Error processing transaction:")
    print("  code: " + result.transaction.processor_response_code)
    print("  text: " + result.transaction.processor_response_text)
else:
    for error in result.errors.deep_errors:
        print("attribute: " + error.attribute)
        print("  code: " + error.code)
        print("  message: " + error.message)

For long-running applications, you can optionally call close() to explicitly release HTTP connections when you're done with a gateway instance:

gateway = braintree.BraintreeGateway(config)

# Process transactions...
result = gateway.transaction.sale({...})

# When completely done with this gateway instance
gateway.close()

When to use close():

• Long-running web applications that create/destroy gateway instances frequently
• Applications with strict resource management requirements
• High-traffic applications with many concurrent threads

When you don't need close():

• Short-lived scripts (resources are cleaned up when the script exits)
• Applications that create a single gateway instance at startup and reuse it
• Most typical use cases (Python's garbage collector handles cleanup automatically)

1. Create a virtualenv called venv:

   virtualenv venv
   

2. Start the virtualenv:

   source venv/bin/activate
   

3. Install dependencies:

   pip3 install -r dev_requirements.txt
   

The Makefile and Dockerfile will build an image containing the dependencies and drop you to a terminal where you can run tests.

make

Our friends at Venmo have an open source library designed to simplify testing of applications using this library.

If you wish to run the tests, make sure you are set up for development (see instructions above). The unit specs can be run by anyone on any system, but the integration specs are meant to be run against a local development server of our gateway code. These integration specs are not meant for public consumption and will likely fail if run on your system. To run unit tests use rake (rake test:unit) or unittest (python3 -m unittest discover tests/unit).

See the LICENSE file for more info.