WooCommerce WePay Gateway

Please note that this extension was retired in February 2017, as WePay no longer allows individual merchants to register for payment processing. This documentation is still available as not all merchants have migrated away from WePay, but new merchants can no longer use this solution.

Accept credit cards and bank accounts on your WooCommerce website with WePay. This extension supports the regular and iFrame checkout. This document will show you how to setup and configure the extension to work with your WePay account.

 

Installation ↑ Back to top

  1. Download the extension from your dashboard
  2. Goto Plugins > Add New > Upload and select the ZIP file you just downloaded
  3. Click Install Now, and then Activate
  4. Click the Configure link and read the next section to learn how to setup and configure the plugin.

 

Setup and Configuration ↑ Back to top

First, login in to your WePay account. If you don’t have an account set up already, you can create one for your business by clicking “+ Create Account”. You’ll need to name your application and enter your URL / description:

WooCommerce WePay Create Application
WePay Create Application

Once you have an account setup with an application, click on “API Application” to view your API keys (or click “Next” if you’re creating a new account / application):

WooCommerce WePay | View WePay Application
View WePay Application

Finally, copy the API information provided to associated text boxes on the WePay Settings page under WooCommerce > Settings > Checkout > WePay.

WooCommerce WePay API Credentials
API Setup – Step 3

That’s it! You are now ready to start accepting credit cards and bank accounts via WePay! If you want to tweak settings and customize the checkout process, or you run into issues with these credentials, keep reading.

 

API Version Unmatched ↑ Back to top

There are some cases in which your account’s API version may not match the plugin’s accepted version. Unfortunately we have no way within the plugin to specify a version, as WePay will automatically set this for accounts and does not allow backwards compatibility.

As a result, you may need to manually have your account API version updated. The plugin will detect API version mismatches after you’ve entered your credentials, and inform you of them if they occur.

WooCommerce WePay API version unmatched
API version mismatch

When this occurs, you must reach out to WePay at this email: API@WePay.com

Please request that your account use the plugin’s current API version: 2016-08-10

You’ll be able to use the plugin when this version is the API version listed in your account, under your app > Configure:

WooCommerce WePay: Account API version

Extension Settings ↑ Back to top

WooCommerce WePay Settings

  • Enabled – This will enable the gateway to be used by customers to checkout.
  • Title – This is the text shown for the payment during checkout and on the Order Received page.
  • Description – This is the text shown under the title during checkout. Limited HTML is allowed.
  • Environment – This controls what environment transactions are posted to — use production unless you have signed up for a WePay staging account.
  • Client ID – This is the Client ID for your WePay account. Follow the steps above to get this.
  • Client Secret – This is the Client Secret for your WePay account. Follow the steps above to get this.
  • Access Token – This is the Access Token for your WePay account. Follow the steps above to get this.
  • Account ID – This is the Account ID for the WePay account where payments will be deposited. Follow the steps above to get this.
  • Staging Client ID – This is the Client ID for your WePay Staging account. Follow the steps above to get this.
  • Staging Client Secret – This is the Client Secret for your WePay Staging account. Follow the steps above to get this.
  • Staging Access Token – This is the Access Token for your WePay Staging account. Follow the steps above to get this.
  • Staging Account ID – This is the Account ID for the WePay Staging account where payments will be deposited. Follow the steps above to get this.
  • Transaction Type – Choose the primary type of transaction your store will process. This defaults to “Goods”. If you are unsure about what to choose here, ask your WePay account rep.
  • Checkout Mode – This controls how the checkout process works. Choose “Redirect” to redirect customers to the WePay website to complete their payment. Chose “iFrame” to keep customers on your website to complete payment. This defaults to “Redirect”.
  • Fee Payer – Select who should pay the fee charged by WePay for processing the payment. Set to “Payer” to charge fees to the person paying (Payer will pay amount + fees, payee will receive amount). Set to “Payee” to charge fees to the person receiving money (Payer will pay amount, Payee will receive amount – fees). Defaults to “Payer”.
  • Accepted Card Logos – This controls the card logos that display during checkout. This is purely cosmetic and has no affect on the cards actually accepted by your merchant account.
  • Debug Mode – Enable this if you are having issues correctly processing transactions. You can either log API requests / responses directly to the checkout / thank you page, save them to the WooCommerce Error Log (found under WooCommerce > System Status > Logs) or both. All debugging messages are cleaned of sensitive information before display, but as a best practice, please do not enable this unless you are having issues with the plugin.

 

Checkout Experience ↑ Back to top

This WePay plugin supports two checkout processes: redirect and iFrame checkout. You can configure which you’d like to use in the extension settings.

iFrame Checkout ↑ Back to top

When the iFrame checkout is used, WePay will be offered as a payment method at checkout. Customers will see accepted card icons, and can click “Continue” to go to the iFramed payment screen.

WooCommerce WePay iframe checkout 1

Customers will see an iframed payment form hosted on the “Pay for Order” page from WooCommerce.

WooCommerce WePay iframe checkout step 2

Once the customer enters payment information and places the order, the customer is directed to the “Order Received” page in WooCommerce.

Redirect Checkout ↑ Back to top

When the redirect checkout is used, WePay will be offered as a payment option at checkout. Customers will see accepted card icons, and can click “Continue” to go to hosted payment page.

WooCommerce WePay redirect checkout step 1

Customers will be taken the the hosted payment page at WePay, which contains only the payment form.

WooCommerce WePay redirect step 2

Once the customer enters payment information then confirms the order, the customer is redirected to the “Order Received” page in WooCommerce.

 

Troubleshooting ↑ Back to top

Having trouble? Follow these steps to make sure everything is setup correctly before posting a support request:

  1. Check that your Client ID, Client Secret, Access Token, and Account ID are correct.
  2. Double-check that your Client ID, Client Secret, Access Token, and Account ID are correct 😉
  3. Enable debug mode to the checkout page and review the errors messages that WePay is providing.
  4. Enable debug both to the logs and submit a support ticket, with the log found under WooCommerce > System Status > Logs as an attachment.

 

Other Information ↑ Back to top

Tokenization / Pre-Approval Support

At the moment, this extension does not support tokenization or pre-approvals for WePay. If you need these features, please submit a support ticket so we can add the feature you need to our product roadmap.

 

Questions & Support ↑ Back to top

Already purchased and need some assistance? Get in touch with a ninja via the help desk.

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top