WooCommerce Setup

Learn how to connect your BlueSnap and WooCommerce accounts

WooCommerce is an open source, e-commerce platform for businesses around the globe. Connect your WooCommerce store to BlueSnap to benefit from the ability to accept card payments worldwide.

Note

You can connect multiple WooCommerce stores (domains) to a single BlueSnap account for streamlined account management. You can also connect other shopping carts to the same BlueSnap account.

Supported features

  • Credit and debit card processing
  • Apple Pay
  • Vaulted Shoppers
  • Built-in fraud protection through Kount
  • 3-D Secure
  • Multi-currency
  • Multi-language
  • Chargeback Management
  • WooCommerce Subscriptions

Requirements

Recommended Versions

We recommend that you use the following versions when using the BlueSnap plugin for WooCommerce. The plugin may work when using older versions of PHP and MySQL as well; however, the following versions have been tested to ensure compatibility.

Plugin/Application
Recommended Version

PHP

5.6 or later

MySQL

5.6 or later

WordPress

4.5.3 or later

WooCommerce

3.0 or later

WooCommerce Pre-Orders

1.4.4 (minimum version supported)

WooCommerce Subscriptions

2.0.8 (minimum version supported)

Software

This guide assumes that you have:

PCI compliance

A PCI compliance of SAQ-A is required.

Setup Steps

Step 1: Configure your BlueSnap account settings

Before you install the BlueSnap extension, complete these steps in your BlueSnap account:

  1. Set up your BlueSnap API Credentials. Make note of your API username and password; you need them in later steps.

  2. Define the authorized IP address for your server.

  3. Configure your payout settings.

Step 2: Install the plugin

Install the BlueSnap Payment Gateway plugin, as follows:

  1. In WordPress, click Plugins > Add New in the left menu.

  2. Search for BlueSnap in the search box in the top-right side.

  3. Click the WooCommerce BlueSnap Gateway plugin and install it.

  4. Click Plugins > Installed Plugins in the left menu.

  5. In the installed plugin screen, activate the following plugins, in this order:

    • WooCommerce
    • WooCommerce Subscriptions (optional)
    • WooCommerce Pre-Orders (optional)
    • WooCommerce BlueSnap Gateway

Important

If these are not activated in the specified order, the installation will not complete properly.

Step 3: Set the Default Currency

Configure the default currency settings for WooCommerce by completing the following steps:

  1. Go to WooCommerce > Settings > General.

  2. Scroll down to Currency Options and set the following:

  1. Click Save Changes.

Step 4: Configure the plugin

Configure the BlueSnap plugin using the following steps:

  1. Click the Settings link below the BlueSnap plugin.
    The BlueSnap page opens.

  2. Configure the following settings.

Note

You can find your BlueSnap information (API credentials, Merchant ID, and more) for the following settings in your BlueSnap Merchant Console in Settings > API Settings.

Setting
Description

Enable/Disable

Select Enable BlueSnap.
This means that BlueSnap appears as a payment option during checkout.



Test mode

Select Enable Test Mode to use your BlueSnap Sandbox account, select the Enable Test Mode option.
Leave the option cleared to use your BlueSnap Production account.



IPN configuration

Copy the URL from this section and use it for the IPN Setup section below.



Title

By default, this is Credit/Debit Cards. This label is presented to the shopper when they choose a payment option during checkout.



Description

By default, this is Pay using your Credit/Debit Card. This describes the payment method during checkout.



API Username and
API Password

Enter your API Username and Password for your BlueSnap account. Use your sandbox credentials if you chose Enable Test Mode above. Use your production credentials if you did not chose Enable Test Mode above.



Merchant ID

Enter your Merchant ID number from your BlueSnap merchant account.

Note: Use the Merchant ID from you sandbox or production environment, as applicable. They are different.



Soft Descriptor

Enter a string, no more than 20 characters in length. This descriptor appears on the shopper's billing statement to help them identify the purchase. You should use the same soft descriptor set in your BlueSnap Console.



3D Secure

If you want to offer 3‑D Secure, contact BlueSnap Merchant Support and ask for 3‑D Secure to be enabled for your account. After that is done, you can select this option to activate 3‑D Secure. For more information on 3‑D Secure, refer to our 3‑D Secure Guide. (Note: This link opens in a new tab.)



Saved Cards

Select this if you want to give logged-in shoppers the option to store their credit card details for future purchases. They can manage their information from their My Account area.



BlueSnap currency converter

BlueSnap works with many currencies (see a complete list here). The BlueSnap plugin for WooCommerce includes a built-in currency converter that you must configure in order to enable successful purchasing via BlueSnap.

Select this option to use the converter.



Select the currencies to display in your shop

Select all the currencies your WooCommerce store supports.



Apple Pay Wallet

If you want to offer Apple Pay as a payment method for your shoppers, contact BlueSnap Merchant Support and ask for Apple Pay to be enabled for your account. After that is done, you can select this option to allow shoppers to pay with Apple Pay.



Logging

Select the Log debug messages option to have communications between WooCommerce and BlueSnap recorded in the process log files. We recommend using this option during the development of your site or if you are experiencing any problems.

To access process logs for the BlueSnap plugin, go to WooCommerce > Status and click the Logs tab.

  1. Click Save Changes.

Step 5: Secure checkout

Ensure that you are using secure checkout by completing the following steps.

  1. Go to WordPress > Settings > General.
  1. In the following URL fields, make sure that the URL begins with https://:
    • WordPress Address (URL)
    • Site Address (URL)

Step 6. IPN Setup

Instant Payment Notifications (IPNs) are webhooks that trigger an HTTP POST message to your WooCommerce account when an important event occurs. Follow the steps below to set up IPNs.

  1. Log in to your BlueSnap account and go to Settings > General Settings.

  2. In the Notifications section, select Receive Instant Payment Notifications.

  3. Update the IPN URL(s) field. The format of the URL should follow this pattern:
    https://www.yourdomain.com/?wc-api=bluesnap

  4. Click Submit.

For more information on IPNs, refer to our IPN documentation.

Step 7: Crontab Setup

We recommend that you add a line to your crontab. The crontab is an application that runs in the server operating the WordPress application, and is in charge of periodic actions. It ensures that subscriptions continue to charge on time even if your WooCommerce store has no traffic, stores automatic renewals, and handles pre-orders.

The crontab file is available to you in most UNIX/Linux based machines, and often can be found in /var/spool/cron. If you are not sure where your crontab file is, reach out to your IT team or hosting provider for more details.

You should add the following line to your crontab file:
*/15 * * * * {wget path} -q -O – {Web domain of your WooCommerce Store}/wp-cron.php?doing_wp_cron

For example:
*/15 * * * * /usr/bin/wget -q -O - http://shoppingcarts.bluesnap.com/wordpress/wp-cron.php?doing_wp_cron

If you have multiple WooCommerce Stores running on the same server, you should add this line for each one of them.

Note: */15 makes the crontab run every 15 minutes. You can change the cron frequency if you wish.

For additional help, contact Merchant Support.

Best practices & tips

Reporting

Use BlueSnap's reporting capabilities to gain a comprehensive understanding of your business through the detailed transaction and payout reports, through payment conversions reports, and much more. Reports can be viewed right in your BlueSnap Console or pulled via the Reporting API to be parsed or pushed to your third-party reporting tools.

WooCommerce Setup


Learn how to connect your BlueSnap and WooCommerce accounts

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.