Latest commit 0affc87 Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github 3.24.0 Aug 10, 2017
lib 3.38.0 Dec 11, 2018
tests 3.38.0 Dec 11, 2018
.gitignore 3.25.0 Aug 25, 2017
ACKNOWLEDGEMENTS.md 3.18.0 Nov 14, 2016
CHANGELOG.md 3.38.0 Dec 11, 2018
Dockerfile 3.37.0 Nov 30, 2018
LICENSE 3.22.0 Feb 16, 2017
Makefile 3.27.0 Jan 18, 2018
README.md Added missing semicolon to arrays items Aug 25, 2018
Rakefile 3.23.0 Apr 13, 2017
ci.sh 3.1.0 Jun 26, 2015
composer.json 3.28.0 Feb 8, 2018
phpunit.xml.dist 3.6.0 Oct 26, 2015

README.md

Braintree PHP library

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

Please Note

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 is updating its services to require TLS 1.2 for all HTTPS connections. Braintree will also require HTTP/1.1 for all connections. Please see our technical documentation for more information.

Dependencies

PHP version >= 5.4.0 is required.

The following PHP extensions are required:

  • curl
  • dom
  • hash
  • openssl
  • xmlwriter

Quick Start Example

<?php

require_once 'PATH_TO_BRAINTREE/lib/Braintree.php';

// Instantiate a Braintree Gateway either like this:
$gateway = new Braintree_Gateway([
    'environment' => 'sandbox',
    'merchantId' => 'your_merchant_id',
    'publicKey' => 'your_public_key',
    'privateKey' => 'your_private_key'
]);

// or like this:
$config = new Braintree_Configuration([
    'environment' => 'sandbox',
    'merchantId' => 'your_merchant_id',
    'publicKey' => 'your_public_key',
    'privateKey' => 'your_private_key'
]);
$gateway = new Braintree\Gateway($config)

// Then, create a transaction:
$result = $gateway->transaction()->sale([
    'amount' => '1000.00',
    'paymentMethodNonce' => 'nonceFromTheClient',
    'options' => [ 'submitForSettlement' => true ]
]);

if ($result->success) {
    print_r("success!: " . $result->transaction->id);
} else if ($result->transaction) {
    print_r("Error processing transaction:");
    print_r("\n  code: " . $result->transaction->processorResponseCode);
    print_r("\n  text: " . $result->transaction->processorResponseText);
} else {
    print_r("Validation errors: \n");
    print_r($result->errors->deepAll());
}

Both PSR-0 and PSR-4 namespacing are supported. If you are using composer with --classmap-authoritative or --optimize-autoloader enabled, you'll have to reference classes using PSR-4 namespacing:

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

// or

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

HHVM Support

The Braintree PHP library will run on HHVM >= 3.4.2.

Google App Engine Support

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

extension = "curl.so"

and turn off accepting gzip responses:

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

Legacy PHP Support

Version 2.40.0 is compatible with PHP 5.2 and 5.3. You can find it on our releases page.

Documentation

Developing (Docker)

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

make

Testing

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.

The benefit of the rake tasks is that testing covers default hhvm and php interpreters. However, if you want to run tests manually simply use the following command:

phpunit tests/unit/

License

See the LICENSE file.