WooCommerce Installation

Linking your WooCommerce store with RevCent.

Overview

Running a WooCommerce store? Just install the RevCent Payments plugin to import products, and begin synchronizing your orders with RevCent’s backend. Updates and fulfillment data will reflect back on your WooCommerce site.

Before You Start

This installation guide assumes the entities below have already been created.

Campaign Created

If you have not created a campaign in RevCent please follow the instructions on Creating A Campaign

Payment Profile Created

If you have not created a payment profile in RevCent please follow the instructions on Creating Your First Payment Profile

Install WordPress Plugin

Login to WordPress

Go to your WordPress site and login as the site administrator.

Search Plugin

  1. Go to the Plugins page in your WordPress site and click the Add New button.
  2. On The Add New page, type revcent in the search bar.
  3. The RevCent Payments plugin box should appear. Continue below.

Install Plugin

WordPress add plugin RevCent panel

  1. Click the Install Now button.
  2. Once installation has finished, click the Activate button.

Plugin Install Complete

Once you have installed and activated the RevCent plugin continue below to Create a WooCommerce API Key.

Create A WooCommerce API Key

You will need to create an API key within WooCommerce so RevCent can communicate with your store.

Note: We recommend opening a text editor so you can copy and paste the credentials that WooCommerce will generate. You will need these credentials later on in this guide.

WooCommerce Settings

WooCommerce sidebar settings

  1. On the WordPress sidebar, click Settings in the WooCommerce dropdown.

Advanced Settings > REST API

WooCommerce settings advanced REST API add key

  1. Once on the WooCommerce settings page, click the Advanced Tab.
  2. In the Advanced settings tab, click REST API.
  3. Once in the REST API section click the Add Key button.

Add Key

WooCommerce settings advanced REST API generate key

  1. For description enter ‘API Key for RevCent integration’.
  2. For user, select the WordPress Admin user.
  3. For permissions, select Read/Write.
  4. Click the Generate API Key button.

Key Generated

Once the key is generated you will not be able to retrieve these credentials later. You need to save them to a text editor on your computer.

WooCommerce settings advanced REST API key details

  1. Copy and paste the Consumer key into a text editor on your computer.
  2. Copy and paste the Consumer secret into a text editor on your computer.

Key Credentials Saved

Once you have copied and pasted both key credentials into a text editor, continue the steps below to create a RevCent shop.

Create A RevCent Shop

Login to RevCent

Visit RevCent and login to your account. If you do not have a RevCent account, click here to sign up.

Create A Third Party Shop

Create a new third party shop by going to https://revcent.com/user/new-third-party-shop

Create third party shop

Name

Set a name for the third party shop. Required.

Description

Set a description for the third party shop. Optional.

Domain

Enter the domain of your third party shop. i.e. ‘myshop.com’ or ‘myshop.com/store’.

Status

Set the status of your third party shop. Default is enabled.

Use Tax Profiles

If you wish to have RevCent automatically calculate and charge tax using a Tax Profile. Select no if your third party shop will provide the tax to be charged.

Campaign

Attach a campaign to your shop. Required.

Payment Profile

Attach a payment profile to your shop. Required.

API Account

Select Create New in the dropdown.

Webhook

Select Create New in the dropdown.

Third Party

Select WooCommerce in the dropdown.

Cart API Version

Enter the API version of your third party shopping cart. Refer to the chart below.

API Version WooCommerce Version WordPress Version
3 3.5.x or later 4.4 or later
2 3.0.x or later 4.4 or later
1 2.6.x or later 4.4 or later
Ready to create
  1. Click the Create New Third Party Shop button after entering all form fields above.
  2. You will be automatically forwarded to the edit page for the new shop. Continue the steps below after being forwarded.

Enter WooCommerce API Credentials

Once you have created your new shop it is time to link your RevCent shop with your WooCommerce installation. We will use the WooCommerce API credentials we generated and save them to our RevCent shop.

Scroll to the bottom of the edit page until you see the WooCommerce API credentials box.

WooCommerce API Credentials Box

WooCommerce API credentials box

Consumer Key

Enter the WooCommerce Consumer Key you pasted in the text editor. It is the key that starts with ck_

Consumer Secret

Enter the WooCommerce Consumer Secret you pasted in the text editor. It is the key that starts with cs_

  1. Click the Test button after entering your credentials. RevCent will test the API credentials to make sure it can connect to your shop.
  2. Click the Save button if the test is successful.
  3. Continue below to finalize the WooCommerce installation.

Finalize WooCommerce Installation

Once you have saved your WooCommerce API credentials and RevCent was able to connect to your WooCommerce store you will see a box below the API credentials form.

Scan And Fix

The box will indicate that the plugin on your store is not set up, this is normal.

Edit third party shop scan fix fail

  1. Click the Scan And Fix button.
  2. Wait for the Scan and fix to complete.

Scan and Fix Success

Once the Scan and Fix has completed, RevCent will check again to make sure your install is finished.

Edit third party shop scan fix success

If you see the above box, you are finished linking RevCent with your WooCommerce store and the installation is complete.

  1. Click the Save Changes button at the bottom of the page.

WooCommerce Installation Complete

Congratulations on completing the WooCommerce installation. Your WooCommerce sales will now process through RevCent.

Import Shipping from WooCommerce

If you sell shippable products on your WooCommerce store you need to import your shipping methods.

Import Products from WooCommerce

Begin importing your products to RevCent directly from WooCommerce by following the Import Products guide.

Import Additional Payment Methods from WooCommerce

If you use additional payment methods in your store we recommend importing them into RevCent. Read more about how to import additional payment methods into RevCent.

WooCommerce & 3DS

You have the ability to pass 3DS values to RevCent when using WooCommerce. This requires a third party implementation, typically a JavaScript SDK, such as PAAY. Conduct the 3DS verification during checkout and pass the returned values to RevCent via form fields.

3DS Fields

When a customer submits payment, the values in the table below can be included in the checkout POST body. If RevCent detects the specific POST field values in the submission body, it will include them in the 3DS payment request RevCent ultimately sends to the payment gateway. Note: The fields marked as Required must be submitted and cannot be empty, else RevCent will ignore the 3DS submission.

POST Field Common Third Party Fields Example Value Description Required
three_ds_eci eci 05 The eci value returned in a successful 3DS verification. TRUE
three_ds_cavv cavv, authenticationValue Y2FyZGluYWxjb21tZXJjZWF1dGg The CAVV a.k.a. authentication value, returned in a successful 3DS verification. TRUE
three_ds_directory_server_id dsTransId, directoryServerTransactionId, directoryServerId 3f6fb1f8-f719-46c9-905b-bab446f4de30 The directory server transaction ID returned in a successful 3DS verification. TRUE
three_ds_version threeDsVersion, threeDSecureVersion, protocolVersion 2.1.0 The 3DS version used for verification. TRUE
three_ds_acs_transaction_id acsTransId d6f15aae-2c9d-4333-a920-954be07c0c76 The acs transaction ID returned in a successful 3DS verification.

Form Example

To submit 3DS fields during checkout, you can create hidden form inputs inside the WooCommerce checkout <form> using JavaScript. When a successful 3DS authentication completes, append the form inputs to the main checkout form, each input having the respective 3DS values. It is important to note the “name” attribute form each hidden form input. The “name” attribute must match the POST field in the table above.

The hidden input values will be sent to the server once the customer clicks the submit button. RevCent will detect the POST values and include the 3DS details in the payment request sent to the gateway.

html
<form name="checkout" method="post" class="checkout woocommerce-checkout" action="https://mystore.com/checkout">
  <input type="hidden" name="three_ds_eci" value="05"/>
  <input type="hidden" name="three_ds_cavv" value="Y2FyZGluYWxjb21tZXJjZWF1dGg"/>
  <input type="hidden" name="three_ds_directory_server_id" value="3f6fb1f8-f719-46c9-905b-bab446f4de30"/>
  <input type="hidden" name="three_ds_version" value="2.1.0"/>
  <input type="hidden" name="three_ds_acs_transaction_id" value="d6f15aae-2c9d-4333-a920-954be07c0c76"/>
  ...All other checkout inputs
</form>

JavaScript Example

Below is an example JavaScript snippet on creating hidden form inputs after receiving a successful PAAY 3DS response. In the example, the input fields are appended to the WooCommerce checkout form. View PAAY documentation on 3DS verification in the browser.

javascript
const createHiddenInput = (name, value) => {
  const newInput = document.createElement("input");
  newInput.setAttribute("type", "hidden");
  newInput.setAttribute("name", name);
  newInput.value = value;
  return newInput;
};

let checkoutFormEl = document.querySelector("form[name='checkout']");
checkoutFormEl.appendChild(createHiddenInput("three_ds_cavv", paay_response.authenticationValue));
checkoutFormEl.appendChild(createHiddenInput("three_ds_eci", paay_response.eci));
checkoutFormEl.appendChild(createHiddenInput("three_ds_directory_server_id", paay_response.dsTransId));
checkoutFormEl.appendChild(createHiddenInput("three_ds_version", paay_response.protocolVersion));