Repository files navigation

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

The Payment Card Industry (PCI) Council hasmandated 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 ourtechnical documentation for more information.

The following PHP extensions are required:

• curl
• dom
• hash
• openssl
• xmlwriter

PHP version >= 7.3 is required. The Braintree PHP SDK is tested against PHP versions 7.3 and 7.4, and 8.0.

The PHP core development community has releasedEnd-of-Life branches for PHP versions 5.4 - 7.2, and are no longer receiving security updates. As a result, Braintree does not support these versions of PHP.

⚠️The SSL certificates for PHP SDK versions older than 6.21.0 are set to expire by June 31, 2025. If you do not update your SDK to the latest version with the updated certificates by June 31, 2025, 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 ourdeveloper docs.

• Official documentation

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

<?phprequire_once'PATH_TO_BRAINTREE/lib/Braintree.php';// Instantiate a Braintree Gateway either like this:$gateway =newBraintree\Gateway(['environment' =>'sandbox','merchantId' =>'your_merchant_id','publicKey' =>'your_public_key','privateKey' =>'your_private_key']);// or like this:$config =newBraintree\Configuration(['environment' =>'sandbox','merchantId' =>'your_merchant_id','publicKey' =>'your_public_key','privateKey' =>'your_private_key']);$gateway =newBraintree\Gateway($config)// Then, create a transaction:$result =$gateway->transaction()->sale(['amount' =>'10.00','paymentMethodNonce' =>$nonceFromTheClient,'deviceData' =>$deviceDataFromTheClient,'options' => ['submitForSettlement' =>True ]]);if ($result->success) {print_r("success!:" .$result->transaction->id);}elseif ($result->transaction) {print_r("Error processing transaction:");print_r("\n  code:" .$result->transaction->processorResponseCode);print_r("\n  text:" .$result->transaction->processorResponseText);}else {foreach($result->errors->deepAll()AS$error) {print_r($error->code .":" .$error->message ."\n");    }}

As of major version 5.x.x, only PSR-4 namespacing is supported. This means you'll have to reference classes using PSR-4 namespacing:

$gateway =newBraintree\Gateway(['environment' =>'sandbox','merchantId' =>'your_merchant_id','publicKey' =>'your_public_key','privateKey' =>'your_private_key']);// or$config =newBraintree\Configuration(['environment' =>'sandbox','merchantId' =>'your_merchant_id','publicKey' =>'your_public_key','privateKey' =>'your_private_key']);$gateway =newBraintree\Gateway($config)

When using Google App Engine include the curl extention in yourphp.ini file (see#190 for more information):

extension ="curl.so"

and turn off accepting gzip responses:

$gateway =newBraintree\Gateway(['environment' =>'sandbox',// ...'acceptGzipEncoding' =>false,]);

TheMakefile andDockerfile will build an image containing the dependencies and drop you to a terminal where you can run tests.

make

The Rakefile includes commands to runPHP Code Sniffer andPHP Code Beautifier & Fixer. To run the linter commands use rake:

rake lint:fix# runs the auto-fixer first, then sniffs for any remaining code smellsrake lint:sniff[y]# gives a detailed report of code smells

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.

To lint and run all tests, use rake:rake test.

See the LICENSE file.