availability

This page is only relevant for:

  • PHP migrating from version 4.8.0 and below,
  • Python migrating from version 3.59.0 and below,
  • Java migrating from version 2.109.0 and below,
  • .NET migrating from version 4.18.0 and below,
  • Node migrating from version 2.24.0 and below.

You can skip this guide if you are using the Ruby Braintree SDK or starting a new integration using the latest version of another SDK.

Overview

Braintree makes regular updates to our server SDKs which follow semantic versioning guidelines. This page will guide you through the largest breaking changes that are specific to the language you are integrating with Braintree. Check the SDK's CHANGELOG for more information on changes.

SDK Major Version 5.0.0

PSR-4 Namespacing

Previous versions of the Braintree SDK supported class aliases with underscores, for instance Braintree_Gateway to support the PHP standard PSR-0. Version 5.0.0 and onward drop support for that standard because it is deprecated, in favor of PSR-4. This may require an update if you were previously using the underscore syntax to load Braintree modules.

If you were using underscores to load modules:

PHP
$gateway = new Braintree_Gateway([
    'environment' => 'sandbox',
    'merchantId' => 'your_merchant_id',
    'publicKey' => 'your_public_key',
    'privateKey' => 'your_private_key'
]);

You should replace those with backslashes:

PHP
$gateway = new Braintree\Gateway([
    'environment' => 'sandbox',
    'merchantId' => 'your_merchant_id',
    'publicKey' => 'your_public_key',
    'privateKey' => 'your_private_key'
]);

If you were using the now unsupported class aliases, you might see errors like the following:

PHP
PHP Fatal error:  Uncaught Error: Class 'Braintree_Gateway' not found in /your/directory/YourFile.php

Exceptions

Down For Maintenance exceptions have been renamed to Service Unavailable exceptions, since we do not bring our services down to perform maintenance operations anymore.

We also added additional timeout exceptions to give extra clarity on the source (client request vs gateway response).

For more information, check our guide on Exceptions.

Further reading