Braintree driver for the Omnipay PHP payment processing library
Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 7.2+. This package implements Braintree support for Omnipay.
Omnipay is installed via Composer. To install, simply add it
to your composer.json
file:
composer require omnipay/braintree:"~4.0@dev"
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 token (payment nonce), which is the method recommended by Braintree. 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();
It also supports making purchases when the credit card number is specified:
$response = $gateway->purchase([
'amount' => '10.00',
'card' => [
'number' => '4111111111111111',
'expiryMonth' => '6',
'expiryYear' => '2025',
'cvv' => '123',
]
])->send();
For general usage instructions, please see the main Omnipay repository.
$customer = $gateway->createCustomer([
'customerData' => [
'id' => 1,
'firstName' => 'John',
'lastName' => 'Doe'
]
])->send();
You can find full list of options here.
$customer = $gateway->findCustomer(1)->send();
You can find full list of options here
$method = $gateway->createPaymentMethod([
'customerId' => $user->getId(),
'paymentMethodNonce' => 'paymentnonce',
'options' => [
'verifyCard' => true
]
]);
You can find full list of options here.
$method = $gateway->updatePaymentMethod([
'paymentMethodToken' => 'token123',
'options' => [
'paymentMethodNonce' => 'paymentnonce'
]
]);
You can find full list of options here.
$subscription = $gateway->createSubscription([
'subscriptionData' => [
'paymentMethodToken' => 'payment_method_token',
'planId' => 'weekly',
'price' => '30.00'
]
])->send();
You can find full list of options here
$subscription = $gateway->cancelSubscription('id')->send();
You can find full list of options here
$notification = $gateway->parseNotification([
'bt_signature' => 'signature',
'bt_payload' => 'payload'
])->send();
You can find full list of options here
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.