Stripe Checkout for VirtueMart User Guide

Stripe Checkout is a payment plugin for VirtueMart. It provides your customers with a streamlined, mobile-ready payment experience. With Stripe Checkout, sensitive cardholder data does not hit your server, greatly minimizing your PCI compliance burden.

Installation

You can download the latest installation package from our site's download page for Stripe Checkout. If you have an older version of Joomla! or VirtueMart or PHP please check the system requirement section to find the version of Stripe Checkout compatible with your Joomla!, VirtueMart and PHP versions.

You can install the installation package of the plugin directly through Joomla Extension Installer. It can also be used to upgrade/update the plugin; just install it without uninstalling the previous release.

Uninstallation

You can uninstall the plugin just like any other Joomla! extensions. In your site's back-end, just go to Extensions Manager, navigate to Uninstall menu, select Stripe Checkout for VirtueMart and click on Uninstall. This will completely remove plugin including all database information.

Configuration

Once the install is completed, you can configure Stripe Checkout payment method in VirtueMart's Payment Methods section just like any other standard payment methods. Click on New button located at the toolbar. In next screen, give a valid name to the payment method and select Stripe Checkout for VirtueMart as the Payment Method. Click on Save button. Once the page reloads, click on Configuration tab. Here you have to provide the required configuration information before the payment method can be made in use.

Stripe Checkout - Required Parameters

Live Update

Download Key

Add your VirtuePlanet download key to receive live updates. The plugin will contact VirtuePlanet's server to validate your entered download key.

Required Parameters

Payment Mode

Set your desired payment mode. Use Test for testing.

Stripe - Publishable Key

Add your Stripe Publishable API key.

Stripe - Secret Key

Add your Stripe Secret API key.

Layout

Logos

Select the images to be displayed with the payment method name. Image Path: images/virtuemart/payment/

Stripe Checkout Options

Stripe Checkout - Options

These parameters are completely optional. You can configure them to fine tune checkout experience.

Shop Name

Shop name is displayed at the top of the Stripe checkout form. If empty, it will show the shop name maintained in VirtueMart's shop settings.

Shop Logo

A square image of your brand or product. The recommended minimum size is 128x128px. The supported image types are: .gif, .jpeg, and .png. Your site must have modern SSL certificate (e.g., TLS 1.2) installed to use this feature.

Payment Button Label

The label of the payment button in the Checkout form (e.g., Subscribe, Pay {{amount}}, etc.). If you include {{amount}} in the label value, it will be replaced by a localized version of amount. Otherwise, a localized amount will be appended to the end of your label. You can also use Joomla language constant if you want.

Show Product Count

If yes, the total product count is displayed below the shop name in Stripe checkout form.

Validate Zip Code

Specify whether Stripe Checkout should validate the billing ZIP code. The default is no, but we highly recommend setting to true and enabling declines on verification failures in your account settings - https://dashboard.stripe.com/account

Collect Billing Address

Specify whether Checkout should collect the user's billing address. The default is no. Collected billing address can be seen in backend order details under payment information.

Allow Remember Me

Specify whether to include the option to Remember Me for future purchases. The default is yes. This feature is dependent on being able to set cookies or use the browser’s localStorage, and may not be available if your customer has certain privacy settings enabled.

Send Email Receipt

The email address used is the Billing Address email (BT). The receipt will not be sent until the charge is paid. If this option is enabled for a charge in live mode, a receipt will be sent regardless of your email settings. For more details, please check https://support.stripe.com/questions/email-receipts

Automatic Refund

If yes, Stripe transaction is automatically refunded when order status is changed to Refunded Transactions status in your site.

Enable Webhook

Stripe can send webhook events that notify your application any time an event happens on your account. This is especially useful for events—like disputed charges, refund etc those are not triggered by a direct API request. You need to setup Webhook in your Stripe account to use this feature. Refer to this documentation to learn more - https://stripe.com/docs/webhooks#configuring-your-webhook-settings

Webhooks are configured in the Stripe Dashboard's Webhooks settings section. Use the following URL in the Stripe Webhooks settings. Your site must have modern SSL certificate (e.g., TLS 1.2) installed to use this feature. Your site specific webhook url can be found in the configuration section of the payment method.

Webhook Endpoint’s Secret

This is completely optional. You need to specify the endpoint's secret if you have setup the same in your Stripe Webhook settings. See - https://dashboard.stripe.com/account/webhooks

Currencies

Stripe Checkout - Currencies
Payment Currency

Select the payment currency for this payment method.

Order Status

Pending Transactions

Select the oder status for pending Stripe transactions.

Successful Transactions

Select the oder status for successful Stripe transactions.

Refunded Transactions

Select the oder status for refunded Stripe transactions.

Partially Refunded Transactions

Select the oder status for partially refunded Stripe transactions.

Failed Transactions

Select the oder status for failed Stripe transactions.

Restrictions

Stripe Checkout - Restrictions
Countries

Select the countries for which this payment method applies. If no country is selected, this payment method will be applied for all countries.

Minimum Amount

Minimum Order Amount to offer this Payment.

Maximum Amount

Maximum Order Amount to offer this Payment.

Publish Start

Select a date to start offering this payment method. Leave empty to skip restriction.

Publish End

Select a date to start offering this payment method. Leave empty to skip restriction.

Fees & Discounts

Fee per Transaction

Flat amount to be applied per transaction. Negative amount can be set for discount.

Percent of the Total Product Amount

Percent to be applied on the total product amount. Shipment cost are not included.

Tax

Select the Tax Rule to be applied on the fees.