Omnipay: Braintree

Braintree driver for the Omnipay PHP payment processing library

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Braintree support for Omnipay.

Installation

Omnipay is installed via Composer. To install, simply add it to your composer.json file:

composer require omnipay/braintree:"~2.0@dev"

Basic Usage

The following gateways are provided by this package:

• Braintree

You need to set your merchantId, publicKey and privateKey. Setting testMode to true will use the sandbox environment.

This gateway supports purchase through a payment token (payment nonce), card reference (token billing) and direct charges through credit card.

For general usage instructions, please see the main Omnipay repository.

Client token

You can generate a clientToken for Javascript:

$clientToken = $gateway->clientToken()->send()->getToken();

The generated token will come in handy when using the Javascript SDK to display the Drop-in Payment UI or hosted fields used to collect payment method information.

On successful submission of the payment form, a one-time-use token that references a payment method provided by your customer, such as a credit card or PayPal account is dynamically added to the form as the value of a hidden payment_method_nonce input field.

Use the payment_method_nonce to process your customer order like so:

$response = $gateway->purchase([
            'amount' => '10.00',
            'token' => $_POST['payment_method_nonce']
        ])->send();

Token billing

Token billing allows you to store a credit card with your gateway, and charge it at a later date.

Create card

$card = new CreditCard();
$card->setFirstName('Mike')
    ->setLastName('Jones')
    ->setEmail('mike.jones@example.com')
    ->setExpiryMonth('05')
    ->setExpiryYear('19')
    // https://developers.braintreepayments.com/reference/general/testing/php#no-credit-card-errors
    ->setNumber('4111111111111111')
    // https://developers.braintreepayments.com/reference/general/testing/php#avs-and-cvv/cid-responses
    ->setCvv('500');
    
$card = $gateway->createCard([
    'customerReference' => 1337, // Braintree Customer ID
    'card' => $card,
])->send();

// Get Braintree token of stored credit card
$card->getCardReference();

Update card

Not yet implemented.

Delete card

Not yet implemented.

Purchase through saved credit card

$transaction = $gateway->purchase([
    'amount' => 25.00,
    'currency' => 'usd',
    'customerReference' => 1337,
    'cardReference' => 'Ax85s9',
])->send();

// Not yet implemented
// $transaction->getTransactionReference();

Driver specific usage

Create customer

$customer = $gateway->createCustomer([
    'customerData' => [
        'id' => 1,
        'firstName' => 'John',
        'lastName' => 'Doe'
    ]
])->send();

// Get Braintree token of stored customer
$customer->getCustomerReference();

You can find full list of options here.

###Find customer (By id)

$customer = $gateway->findCustomer(1)->send();

You can find full list of options here

###Create subscription

$subscription = $gateway->createSubscription([
    'subscriptionData' => [
        'paymentMethodToken' => 'payment_method_token',
        'planId' => 'weekly',
        'price' => '30.00'
    ]
])->send();

You can find full list of options here

###Cancel subscription

$subscription = $gateway->cancelSubscription('id')->send();

You can find full list of options here

###Parse webhook notification

$notification = $gateway->parseNotification([
    'bt_signature' => 'signature',
    'bt_payload' => 'payload'
])->send();

You can find full list of options here

Support

If you are having general issues with Omnipay, we suggest posting on Stack Overflow. Be sure to add the omnipay tag so it can be easily found.

If you want to keep up to date with release anouncements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.