Stripe Express - Magento 1 - Documentation

About

Stripe Express is a add-on to our popular Stripe Payments module for Magento 1, which allows faster checkouts from the product pages through Apple Pay, Android Pay, Google Pay and Microsoft Pay. This is the documentation for installing, configuring and using this module on Magento 1.

Installation

Warning! We recommend that you test the module on a testing server before installing it on your live web server. Please see the Troubleshooting section if you come across any installation issue.

  1. Before installing this module, make sure that you have the latest version of Stripe Payments installed. You can check which is the latest version from the Changelog section towards the bottom of the product page. You can check which version you have installed from System > Magento Connect > Magento Connect Manager. If you have an older version, see the upgrade instructions here.
  2. If you haven't done so already, please download the Stripe Express add-on from your customer account section or through the email that was sent to you when you purchased the module.
  3. Log into your website's magento admin section.
  4. Make sure that compilation is disabled from System > Tools > Compilation.
  5. Go to System > Magento Connect > Magento Connect Manager and log in.
  6. Under «Direct package file upload», upload the .tgz file that you downloaded from our website.
  7. Click the «Install» button when the module has uploaded successfully.
  8. Check the black console to make sure that there were no errors.
  9. If you had compilation enabled, recompile from System > Tools > Compilation.
  10. Under System > Cache Management, flush all of your caches, including Merged CSS/JS if those are enabled
  11. If you haven't done so already through the installation of Stripe Payments, proceed to configure Apple Pay on your website.

Manual Installation

If for any reason the above procedure did not work (usually because the web server has no write permissions in your Magento directory), then you can install the module manually by simply extracting the module in your Magento's root directory.

  1. Double click the .tgz file to uncompress it. If you are on a version of Windows that does not support this, we recommend using the 7-Zip file archiver to uncompress the module.
  2. Upload the extracted files by FTP to your website, inside your website's root Magento directory. If you do not have an FTP client already, you can use FileZilla.
  3. A single page refresh of your website will set up the module and its database dependencies.
  4. Flush your site's caches, merged CSS and Javascript, and re-run compilation if necessary.

Uninstall

If you have installed the module from Magento Connect Manager, it should be just as simple to uninstall through the same interface as shown in the following screenshot:

Magento How to uninstall Stripe Express

If you have installed the module manually, you will need to manually delete each file and directory listed in the Failed/Partial/Corrupted Installations section.

Upgrade

Important: If you have Stripe Payments installed as well, always upgrade both modules to their latest version.

You can always download the latest version of the module from your account. Once you have the latest version:

  1. If you have installed the module through Magento Connect Manager: Simply uninstall and re-install the module using the same instructions as above.
  2. If you have installed the module manually, you will need to manually delete each file and directory listed in the Failed/Partial/Corrupted Installations section before installing the newer version. If you simply overwrite them, you may run across template fallback issues. Once the files are removed, we always recommend the magento connect manager installation method, otherwise you can re-install using the manual method.

Configuration in Magento

  1. If you haven't done so already through the installation of Stripe Payments, proceed to configure Apple Pay on your website.
  2. Go to System > Configuration > Payment Methods
  3. Expand the section of any payment method you need to configure as shown in the following screenshot:

    Magento Stripe Express Configuration Section

  4. Cart Express Checkout: Enable or disable the payment button at the Shopping Cart page.
  5. Product Express Checkout: Enable or disable the payment button at the product pages.
  6. Save Customer Cards: Enable if you want to save customer cards through a secure, PCI compliant tokenization method. If the customer ever visits the actual checkout page, they will be able to reuse their saved cards to checkout faster.
  7. Button Type: Choose between 3 types of payment buttons to display: Default, Buy and Donate
    Stripe Google Pay button Default type Stripe Google Pay button Buy type Stripe Google Pay button Donate type
    Stripe Apple Pay button Default type Stripe Apple Pay button Buy type Stripe Apple Pay button Donate type
  8. Button Theme: Choose between 3 types of button themes: Dark, Light and Light-Outline
    Stripe Google Pay button Dark Stripe Google Pay button Light Stripe Google Pay button Light Outline
  9. Button Height: Adjust the button height to match your theme's "Add to Cart" and "Proceed to Checkout" buttons. Stripe Apple Pay button height

Translations for multi-language websites

The module contains a translations file that can be used with multi-language Magento configurations. You can find this file under:

app/locale/en_US/Cryozonic_StripeExpress.csv

To translate the file, copy it to:

app/locale/languagecode_COUNTRYCODE/Cryozonic_StripeExpress.csv

These would be the same language codes that you selected under System > Configuration > General > General > Locale Options > Locale for each of your available stores. If you must set your Locale configuration for the first time, make sure to also flush your Configuration Cache after doing so.

The actual payment button will be automatically translated based on the language detected on your website.

Troubleshooting

General Guidelines

Most issues can be resolved using the Troubleshooting instructions of the Stripe Payments module. If anything is missing from these, please contact us at info@cryozonic.com.

The payment button does not appear

Possible reasons for the button to not display are the following:

  1. A step may have been missed from the Apple Pay Configuration Checklist. Please review the checklist to make sure that all steps have been followed.
  2. You may have overwritten the Add to Cart button template in your theme. This is what the default template looks like:

    If it looks different in your case, try adding some text in app/design/frontend/base/default/template/cryozonic_stripeexpress/product_button.phtml to see if it appears on the product page. If it doesn't, you will need to find the customization in your theme and integrate the two templates together.
  3. There might be some javascript crashes when Stripe.js is initializing, for example if you have entered your Stripe API keys the wrong way round. Check your browser console for any javascript errors related to Stripe.js
  4. You may be serving your product page without SSL, which is required for the button to appear.

Failed/Partial/Corrupted Installations

If you have received errors in the black installation console, or you get crashes during the checkout page only, you may have a partial/corrupted installation because of incorrect filesystem write permissions. For corrupted installations you will need to manually uninstall the module by deleting the following files:

app/design/frontend/base/default/layout/cryozonic_stripeexpress.xml
app/design/frontend/base/default/template/cryozonic_stripeexpress
app/design/adminhtml/base/default/layout/cryozonic_stripeexpress
app/design/adminhtml/base/default/template/cryozonic_stripeexpress
skin/frontend/base/default/cryozonic_stripeexpress
app/locale/en_US/Cryozonic_StripeExpress.csv
app/code/community/Cryozonic/StripeExpress
app/etc/modules/Cryozonic_StripeExpress.xml

A corrupted installation may be caused by incorrect Magento directory permissions. Most of these problems can simply be fixed by changing the ownership of the Magento directories to the user running the webserver with:

$ chown –R <www-username> /magento_directory

Alternatively you can configure your webserver to run as the same user that deploys these files to your website.

If you do not have shell access to run the above command, the only other solution would be to perform a manual installation and upload the files to your Magento directory over FTP.