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

3-D Secure
Auth/Capture and Separate Auth and Capture
Built-in Fraud Prevention and Risk Management
Chargeback Management
Multiple Currencies and Multiple Languages
Partner Sandbox Testing
Payment Analytics and Reporting
Payment Methods: ACH/ECP, Apple Pay, Credit/Debit Cards, and Splitit
Payment Optimization
Vaulted Shoppers
WooCommerce Pre-orders
WooCommerce Subscriptions

Requirements

Software

This guide assumes that you have:

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 Versions

PHP

7.2.11 or later

MySQL

5.5.60 or later

WordPress

5.2.4 or later

WooCommerce

3.7.0 or later

WooCommerce Pre-Orders

1.5.16 or later

WooCommerce Subscriptions

3.0 or later

Supported currencies

BlueSnap supports the currencies listed here. We recommend configuring your store to only accept currencies supported by BlueSnap.

Supported countries

BlueSnap supports the countries listed here. If a shopper is located in one of these supported countries, they will be able to purchase with the BlueSnap payment module.

PCI compliance

A PCI compliance level of SAQ-A is required.

Step 1: Configure your BlueSnap account settings

Complete these steps in your BlueSnap Console for production or sandbox.

  1. Get your BlueSnap API credentials and define the authorized IP addresses for your server. Both of these actions are performed on the same page; for instructions click here.

  2. Set up your statement descriptor. The statement descriptor is the description that appears on the shopper's credit card statement or bank statement for each transaction and helps the shopper identify the transaction.

  • Go to Settings > General Settings.
  • In the Branding Settings section, enter a Default Statement (Soft) Descriptor and Support Phone Number (both appear on the shopper's statement).
  • Click Submit.
  1. To get paid, you need to configure your payout settings. Refer to Payout for more information.

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 choose 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.

Capture

If selected, charges will be automatically captured. If not selected, an authorization will be issued that will need to be captured later. See Managing orders for details.

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 accept Apple Pay, 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.

  2. If you would like to accept ACH payments, enable this feature by going to WooCommerce > Settings > Payments and setting the BlueSnap ACH toggle to enabled.

  3. Click Save Changes.

📘

ACH and subscriptions

If you plan to offer ACH as a payment method for subscriptions, please note:

  • You will need to contact Merchant Support to have this feature enabled.
  • ACH is not supported for subscriptions with daily billing, as banks take several days to authorize these charges.

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. If you plan to offer ACH as a payment method for subscriptions, make sure to select Send Subscription Charge Failure.

  5. 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.

Styling your payment form

BlueSnap supports the ability to customize the card elements (such as text color or font size) of the payment form. To do this, edit the BlueSnap plugin's JavaScript by creating a bluesnapStyleOverrides object that contains your styling. See Supported selectors and Supported CSS properties for details. Use the code below as a starting point.

const bluesnapStyleOverrides = {
  '.invalid': {
    //style all invalid elements
    color: 'red'
  },
  '.valid': {
    //style all valid elements
    color: 'green'
  },
  ':focus': {
    //style all elements on the focus event
    color: 'orange'
  },
  '#ccn': {
    //style only the card number element
    color: 'blue'
  },
  '#cvv': {
    //style only the CVV element
    'font-size': '30px'
  }
};

Customizing error messages

BlueSnap allows you to customize the messages of any errors that occur, giving you full control over the error descriptions that display in the UI or in error logs. To use this feature, you'll need to add custom code to your WooCommerce account. We recommend using a plugin such as Code Snippets to accomplish this.

Use the code sample below as a starting point. You can change error descriptions and add/remove errors from the code below.

add_filter(
  'wc_gateway_bluesnap_api_errors',
  function ( $errors ) {
      $errors = array(
          '10000|INVALID_API_VERSION'        => __( 'API version is not correct...', 'woocommerce-bluesnap-gateway' ),
          '10001|VALIDATION_GENERAL_FAILURE' => __( 'This is a val.gen. failure error.', 'woocommerce-bluesnap-gateway' ),
          '14002'                            => __( 'This is the new error message for 14002', 'woocommerce-bluesnap-gateway' ),
          '14002|SYSTEM_TECHNICAL_ERROR'     => __( 'This is the new error message for 14002|SYSTEM_TECHNICAL_ERROR', 'woocommerce-bluesnap-gateway' ),
          '14016'                            => __( 'This is the new error message for 14016', 'woocommerce-bluesnap-gateway' ),
      );
      return $errors;
  }
);

More error codes can be found in our Developer Hub. See:

Managing orders

If card charges are not automatically captured, they will result in authorizations that need to be captured later. For example, if you sell physical goods, you'll need to capture the authorization when the items are ready to be shipped out. Orders can be conveniently managed from your WooCommerce account by following these steps:

  1. Go to WooCommerce > Orders and click the order that you want to manage. The order's status will be On hold.

    Note: ACH charges can also have a status of On hold.

  2. In the Status dropdown, select one of the following:

    • If you want to capture the authorization, select Processing or Completed.
    • If you want to cancel the authorization, select Cancelled.

Best practices & tips

Considering shopper impact of currency conversions

While transactions are placed in your store’s base currency, you might have your store configured to display product prices in multiple currencies. To account for any differences between the currency conversion rates used to display prices on your website and the rates used by the shopper’s issuing bank, we recommend including a note on your checkout page that informs shoppers of potential price variations. For example: “The price listed is approximate and may vary slightly”.

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.

Updated 18 days ago

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.