Overview
Click the button below to download the Roqqett plugin for WooCommerce, which allows you to add Roqqett Pay and/or Roqqett Checkout to your WooCommerce site. Then follow the quick steps below to install the plugin and start taking Roqqett payments.
Click to download the WooCommerce plugin
info
The GitHub repository for the plugin can be found here.
Setup instructions
Before you begin
- Ensure you have downloaded the plugin.
- Ensure you have registered and have your API key at hand.
- Ensure your organisation settings are configured correctly in the portal .
- Ensure you have created at least one instance of Roqqett Pay or Roqqett Checkout .
- Ensure you fully understand the payment flow .
Step 1: install the plugin in WordPress
-
Log in to your site's admin portal (usually
www.yourwebsite.com/wp-admin/) . - Go to the Plugins area of your site.
- Click the Upload button in the top right, then click the grey file selector, and find where you downloaded the Roqqett plugin.
-
Upload the plugin's
.zipfile. This should automatically install the plugin, though you may be asked to activate it.
info
Some browsers, such as Safari, will automatically unpack the .zip file into a normal directory, but you need to upload a .zip file. You can change this behaviour by going to Safari > Settings in the menu bar. In the General tab, uncheck Open "safe" files after downloading. This will stop Safari from automatically unzipping the files.
Step 2: configure Roqqett in WooCommerce
- In WooCommerce, go to Settings > Payments .
- Click the All payment methods link in the top left (usually immediately under any warning bars). It's next to pre-selected WooCommerce Payments link.
- In the All payments screen, click the Manage button on the Roqqett table row. This opens the settings screen of the Roqqett plugin.
- Set the values as described in the table below, then save.
info
Some of the settings are only for Roqqett Pay, whereas some are only for Roqqett Checkout.
| Setting | Value | Product(s) |
|---|---|---|
| Enable/Disable | Ticked = Roqqett plugin active in WooCommerce. | All |
| Test mode | Unticked = test mode inactive. | All |
| API secret | Your API secret from the Roqqett portal. | All |
| Roqqett Pay - Checkout ID | The ID of the Roqqett Pay instance configured in the Roqqett portal. | Roqqett Pay |
| Roqqett Pay - Expiry period | The number of minutes you give customers to pay before the payment session expires. By default, this is set to 20 minutes. | Roqqett Pay |
| Roqqett Checkout - Checkout ID | The ID of the Roqqett Checkout instance configured in the Roqqett portal. | Roqqett Checkout |
| Roqqett Checkout - Button colour | Select the colour scheme for the Checkout button on your basket summary page. | Roqqett Checkout |
| Roqqett Checkout - Expiry period | The number of minutes you give customers to pay before the payment session expires. By default, this is set to 20 minutes. | Roqqett Checkout |
| Enable logging | Ticked = activity will be logged. This can be useful for support purposes. | All |
Step 3: enable Roqqett in WooCommerce
Before going live, you should enable Roqqett in your WooCommerce payment settings. To do so, go back to the table with all the WooCommerce payment methods, find Roqqett, and slide the toggle switch over so that it is enabled. The toggle switch's background will change to maroon. Lastly, just to be safe, double-check whether or not you are in test mode.
Plugin webhook callback URL
To ensure your Roqqett products work with the plugin, it's essential that the correct webhook callback URL has been added to the settings of Roqqett Pay and/or Roqqett Checkout you intend to use.
The webhook callback URL that you need to use is displayed at the top of the plugin's settings page (in WooCommerce) and will follow this format: <yourWooSiteURL>/wc-api/roqqett-webhook.
This callback URL needs to be added as the Webhook URL in the instance configuration. If an existing instance needs to be updated, select the checkout and use the Update Checkout form.