README

Lightrail is a modern platform for digital account credits, gift cards, promotions, and points —to learn more, visit Lightrail. The Lightrail Stripe integration provides a client library for developers to easily use Lightrail alongside Stripe in PHP.

If you are looking for specific use-cases or other languages, check out the Integrations section of the Lightrail API documentation.

Features

Simple order checkout supporting split-tender transactions with Lightrail redemption alongside a Stripe payment.

Usage

For a sample project using this library, check out the Lightrail Stripe Sample PHP Web App.

Installation

Composer

You can add this library as a dependency to your project using composer:

composer require lightrail/lightrail-stripe

Alternatively, you can copy all the files and add init.php to your project:

require_once 'lightrail-stripe/init.php';

Requirements

This library requires PHP 5.6 or later.

Dependencies

The only dependencies of this library are Stripe and firebase/php-jwt.

"require": {
    "stripe/stripe-php": "^5.3",
    "firebase/php-jwt": "^5.0"
  }

The following dependency is also necessary if you want to run the unit tests.

"require-dev": {
    "phpunit/phpunit": "^6.2"
  }

Tests

Copy ~test-config.php to test-config.php and fill in the blank fields.

Tests can be run from tests/ with ../vendor/bin/phpunit ./

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Giftbit/lightrail-stripe-php.

Publishing

After pushing changes to Github, tag a new release. You can do this via the web interface or through the command line:

git tag -a vX.X.X -m "Tag message or title"
git push origin vX.X.X

Then log into packagist.org and click "Update" on the lightrail/lightrail package (you must be logged in as the Lightrail user).

License

This library is available as open source under the terms of the MIT License.

lightrail / lightrail-stripe

Maintainers

Details