alext/silverstripe-btpayment

Integrate Braintree payment form in Dropin UI.

Installs: 29

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:silverstripe-vendormodule

v0.6 2018-04-05 02:40 UTC

This package is not auto-updated.

Last update: 2021-11-24 14:48:39 UTC


README

A SilverStripe module to integrate Braintree payment forms in Dropin UI.

Currently there're following forms:

  • Make a payment form:

make_payment.png

  • Add/remove payment methods in the vault:

manage_methods.png

When there's no payment method in the vault, the form allows user to add a new payment method:

add_payment.png

Both forms (v0.6) allow user to authorize paypal:

authorize_paypal.png

  • Display previous transactions simple list

transactions.png

Support SilverStripe 4.

Installation

Use composer to install/update:

composer require alext/silverstripe-btpayment

Braintree settings

After installing and rebuilding (\dev\build?flush) go to site admin - Settings and input Braintree settings, see screenshot below:

settings.png

SilverStripe member and Braintree customer

This module extends SilverStripe member's data to create a Braintree customer for each member and store its customer id in database.

Braintree customer will be created on the fly at the first time using the forms if there's no customer id found.

Usage

  • To use the make payment form, use $BTPaymentForm in your template of the page.

Example:

[SamplePayment.ss]
<!-- BEGIN MAIN CONTENT -->
    $BTPaymentForm
<!-- END MAIN CONTENT -->

The page controller must extend BraintreePageController

use AlexT\BTPayment\BraintreePageController;

class SamplePaymentPageController extends BraintreePageController {
}
  • To use the payment methods management form, use $BTEditPaymentForm($amount) in your template, if $amount is not specified 0 (zero) will be put in place.

Example (in case we process the payment in the separate page, set the total amount on the fly):

[SamplePaymentManagement.ss]
<!-- BEGIN MAIN CONTENT -->
    $BTEditPaymentForm
<!-- END MAIN CONTENT -->

Example if we want to change the total amount on the fly:

[PaymentPage.ss]
<h3>Select a property to purchase:</h3>
<p><p>
<select id="js-select-property">
    <option value="0">----- Select property -----</option>
    <% loop $FeaturedProperties %>
        <option value="{$PricePerNight}">{$Title}</option>
    <% end_loop %>
</select>
<hr>
$BTPaymentForm
-----
[scripts.js]
$('#js-select-property').on('change', function (e) {
    $('.js-bt-amount').val($('#js-select-property').val());
});

The page controller must extend BraintreeEditPageController

use AlexT\BTPayment\BraintreeEditPageController;

class SamplePaymentManagementPageController extends BraintreeEditPageController {
}
  • To use the previous transactions form, use BTPreviousTransactionsForm in your template.

Example:

[SamplePaymentManagement.ss]
<!-- BEGIN MAIN CONTENT -->
    $BTPreviousTransactionsForm
<!-- END MAIN CONTENT -->

The page controller must extend BraintreePageController.

To manually handle the transaction yourself, override function processPayment($session, $form, $nonce, $amount) to do your own transaction, for example:

public function processPayment($session, $form, $nonce, $amount) {
    $gateway = BraintreeExtension::BTGateway();
    // make a transaction
    $result = $gateway->transaction()->sale([
        'amount' => $amount,
        'paymentMethodNonce' => $nonce,
        'options' => [
            'submitForSettlement' => true
        ]
    ]);

    if ($result->success || !is_null($result->transaction)) {
        // clear session if everything is fine
        $session->clear("FormData.{$form->getName()}.data");
        $form->sessionMessage('A payment of ' . $amount . '$ has been made!', 'Success');
    } else {
        // ERROR
        $errorString = "";

        foreach ($result->errors->deepAll() as $error) {
            $errorString .= 'Error: ' . $error->code . ": " . $error->message . "\n";
        }

        $form->sessionError('Unable to make a payment! ' . $errorString, 'Failure');
    }

    return $this->redirectBack();
}