Set Up Your Server

Install and configure

availability
The Braintree PHP SDK requires PHP version 7.3.0 or higher and the PHP cURL extension.

Get started with our PHP library by hitting the download link below. Download PHP library

Version: 6.18.0
SHA256: 30b93c3efb926228f076207d6d7c7b32e28ec2a25d51d0fd45e23e0ce65c160e

Or use composer

Composer is a package manager for PHP. In the composer.json file in your project add:

Javascript

{
  "require" : {
    "braintree/braintree_php" : "6.18.0"
  }
}

And then run:

Javascript

php composer.phar install

In your code, configure the environment and API credentials:

PHP

$gateway = new BraintreeGateway([
  'environment' => 'sandbox',
  'merchantId' => 'use_your_merchant_id',
  'publicKey' => 'use_your_public_key',
  'privateKey' => 'use_your_private_key'
]);

note
See the Braintree PHP SDK Version Changelog.

Generate a client token

Your server is responsible for generating a client token, which contains all authorization and configuration information your client needs to initialize the client SDK to communicate with Braintree. Including a customerId when generating the client token lets returning customers select from previously used payment method options, improving user experience over multiple checkouts.

PHP

// pass $clientToken to your front-end
$clientToken = $gateway->clientToken()->generate([
    "customerId" => $aCustomerId
]);

If the customer can't be found, it will throw an InvalidArgumentException.

Set Up Your Client covers the client side of the exchange.

Send a client token to your client

Here is an example of how your server would generate and expose a client token:

PHP

echo($clientToken = $gateway->clientToken()->generate());

How the token is used by the client may vary. In JavaScript integrations the client token is often included in the generated HTML/JS, while in mobile apps the client token must be requested. These methods are discussed in the client token setup section.

Receive a payment method nonce from your client

Once your client successfully obtains a customer payment method, it receives a payment_method_nonce representing customer payment authorization, which it then sends to your server.

Your server implementation is then responsible for receiving the payment_method_nonce and using it appropriately.

PHP

$nonceFromTheClient = $_POST["payment_method_nonce"]
/* Use payment method nonce here */

Create a transaction

You can create a transaction using an amount and the nonceFromTheClient you received in the previous step.

Collect device data from the client and include the deviceDataFromTheClient in the transaction.

PHP

$result = $gateway->transaction()->sale([
  'amount' => '10.00',
  'paymentMethodNonce' => $nonceFromTheClient,
  'deviceData' => $deviceDataFromTheClient,
  'options' => [
    'submitForSettlement' => True
  ]
]);

The sale call returns a Transaction Result Object which contains the transaction and information about the request.

Test your integration

See our Testing page for values you can use for nonceFromTheClient in your sandbox account. These nonces can be passed as strings through server-side calls to generate payment methods in the desired state. To verify your integration, you can check in the sandbox Control Panel, where transactions will immediately appear on success.

important
Always develop and test your code against your sandbox account before processing live transactions against a production account.

Transition to production

At this point, you should be able to accept a payment method nonce and create a transaction in our sandbox. When you're ready to start charging real money, transition over to our production environment. We'll explain that process next.