elkadrey/omnipay-stripe-checkout

Payment Gateway driver for Stripe (Checkout)

3.1.4 2024-07-15 09:11 UTC

Requires

• php: ^8.1
• omnipay/common: ^3.2
• stripe/stripe-php: ^9.6

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.11
• omnipay/tests: ^4.1

MIT

• Glenn Jenkins

• payment
• checkout
• pay
• gateway
• stripe
• merchant
• omnipay

README

Stripe (Checkout) driver for the Omnipay PHP payment processing library

Omnipay implementation of the Stripe payment gateway using their "Checkout" process.

Compatibility

There are two versions of this driver; one is compatible with Omnipay v3, the other with Omnipay v2.

If any changes are made to one, please make sure those changes are ported to the other, where appropriate.

Omnipay v3

This is the master branch, and is released as v3.*.*

Please note, the maintainers of this package have no (easy) way of testing this version and rely on any contributors testing their changes.

Omnipay v2

This is the omnipay-v2 branch, and (for historical reasons) is released as v1.*.*

Installation

Important: Driver requires PHP's Intl extension and PHP's SOAP extension to be installed.

The Stripe (Checkout) Omnipay driver is installed via Composer. To install, simply add it to your composer.json file:

Omnipay v3

{
    "require": {
        "elkadrey/omnipay-stripe-checkout": "~3.0"
    }
}

Omnipay v2

{
    "require": {
        "elkadrey/omnipay-stripe-checkout": "~1.0"
    }
}

And run composer to update your dependencies:

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

What's Included

This driver handles transactions being processed by the "Checkout" process of Stripe.

It is Strong Customer Authentication-aware.

It assumes you will use the redirect method in the browser page (ie that you will not host the card form yourself).

We have done the minimum necessary to get our system to work. If you need any further functionality, please submit a pull request (or ask us to make the change)

It supports refunds, but currently it only handles refunding the full amount of a transaction.

Note: the Stripe API does not support negative- or zero-value items, so this driver filters them out. Be aware that the amount the customer pays is only calculated from that filtered set of items, so if there are deductions, etc in your cart, they will not be taken off the payment amount. And of course zero-value items will not be shown on the card form.

What's Not Included

TBC

Basic Usage

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

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 believe you have found a bug in this driver, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.