Documentation

Pre-install

This package requires concrete5.5.1 or higher and the eCommerce package version 2.8.3 or higher to install. 

Post-install configuration and testing

Once the package is installed, it can be enabled via Dashboard->Payment and Sales Tax (under the eCommerce heading). By default, the payment method will be installed with the name 'Stripe Payment Gateway'.

Each Stripe account provides two pairs of API keys - a pair of keys for testing and a pair for live transactions. The values can be found on your Stripe account page: https://manage.stripe.com/#account

Enter these four values into the payment method configuration form, select the currency to use, select 'Yes' for enabled and press the Save button to enable the payment method.

Testing

After enabling, the Stripe Payment Method will be available for selection on checkout. For test credit card numbers, refer to: https://stripe.com/docs/testing

For a quick success test, simply use the card number 4242 4242 4242 4242 and any valid expiry date and CVC number.

Going Live

To start processing live transactions you need to:

  • Put your Stripe account into live mode. This requires logging into your account, completing any activation steps and switching to live mode.
  • Edit the payment method in your concrete5 site, change the mode to 'Live'. It is also wise to double check your API keys at this point.
  • Although technically not a requirement, it is highly encouraged (and pretty much expected) that your site employs a SSL certificate for handling of customer data and displaying the payment button.

Stripe Charge ID

When the payment method is installed it will automatically create a new order attribute called 'Stripe Charge ID'. This field is useful to match transactions in the Stripe administration with orders concrete5. When the payment method is enabled, it will also automatically display this field in the Orders Search dashboard page, where it can be searched for.

The Stripe Charge ID is not shown on order emails or order details summaries, however it is trivial to search for an order by the order number and then use the Stripe Charge ID attribute to find the matching transaction in Stripe.

Stripe Charge ID values can also be entered into the search field in Stripe's administration, to quickly find a specific transaction. 

Styling the button and form

This payment method uses scripts directly from Stripe to create the checkout payment button and the form overlay. This means that their appearance is mostly fixed and can only be changed in terms of labels (and they may have their look and feel updated in the future).

If you wish to change the text used on the button and/or form, there are options that can be manually edited using an override. You can override the file form.php by copying it to /models/core_commerce/payment/method/stripe/form.php and make changes to the data- attributes on the script tag (this should be obvious). See the Configuration Options section of the page https://stripe.com/docs/checkout

Browser Support

As the Stripe button is implemented using Stripe's 'Checkout' script, directly provided by Stripe browser support is as per what this script supports. The button is known to support nearly all modern browsers and has been developed to specifically support mobile devices.

Although Stripe claims to support older browsers, as Stripe updates this script over time please be aware that Stripe may be phasing out support for older browsers such as IE6, 7 and 8. The support for such browsers is out of the add-on's control.

Currency Support

Stripe currently supports US dollars, Canadian dollars, Euros, British Pound Sterling and Australian dollars (in beta).

Refer to Stripe's currency FAQ page for more information.