WordPress + WooCommerce

Features

Our WordPress plugin (available here) allows you to:

  1. Register new customers and generate a BPAY reference
  2. Take user-specified amounts from a customer's credit card (useful for taking donations)
  3. Take credit card payments through any WooCommerce-enabled website.

Step 1. Get your API Username and Password

The widget relies upon our API, so you will need to create an API user on your Pay Advantage account. The following steps are required in later steps, so please do this.

Note: The only piece of information you will need is your WordPress site server's IP address. This is found in your admin settings or by contacting your server administrator.

Please follow these steps to create an API user:

  1. Login to your Pay Advantage account
  2. Click "More → API"
  3. Enter in the IP Address of your server as a new Entry in the IP Restriction section, with the description "Wordpress Host IP" followed by the entry (e.g. 10.200.1.1). Note: If you do not see this section, please contact Support to enable our API on your account.
  4. Now you need to add an API user using the button "Add API User".
  5. Enter in "Wordpress Host" as the description. Screen_Shot_2019-01-24_at_10.46.31_am.png
  6. You should now have an API user to use in your WordPress Pay Advantage plugin settings (shown later) Screen_Shot_2019-01-24_at_10.47.13_am.png

Step 2. Download and install our WordPress plugin

  1. In your WordPress admin area, navigate to "Plugins" → "Add New"
  2. Search for "Pay Advantage". Click "Install Now"
  3. Once installed, press "Activate"
  4. Navigate to "Settings" → "Pay Advantage"
  5. Enter in your API username and password determined above. Click "Test" to check if they are right. Note: This is your API credentials and NOT your general Pay Advantage username and password. If you have any issues, please contact Support. Screen_Shot_2019-01-24_at_9.48.23_am.png

Step 3. Use one of our widgets or WooCommerce integration

Widget Option 1: Register new customers and generate a BPAY reference

This is particularly useful if you want to add an easy way for your customer's to generate BPAY details for themselves, so that they can send you payments.

This option is enabled via the use of a WordPress widget. You can implement this widget on any widget area, post or page. You won't need much knowledge of widgets to get this working on your site, but if you want more information please see this article.

When added to the site, the customer will see a widget like this (styled according to your theme):

Screen_Shot_2019-01-24_at_9.34.44_am.png

Once they fill the form and press "Register", they will be shown something similar to this:

Screen_Shot_2019-01-24_at_9.36.40_am.png

From here they will be able to use the Biller Code and Ref numbers to make payments to you (the client). They will also be sent an email with their BPAY details.

To add the widget to your WordPress website:

  1. Click "Settings → Pay Advantage". Ensure that you have your API username and password entered in.
  2. You can customise the widget with additional options on this page. Screen_Shot_2019-01-24_at_9.49.19_am.png
  3. Press "Save Changes"
  4. Navigate to "Appearance" → Widgets
  5. Add the widget "Pay Advantage - Generate BPAY Reference" anywhere you like (for example in your sidebar). For instructions on how to use Widgets please see this article. You can add an optional Title that will appear above the widget on your page if you would like. Screen_Shot_2019-01-24_at_9.50.20_am.png
  6. You can adjust your settings anytime in "Settings → Pay Advantage"

You should now be able to see the widget on your page wherever the widget area is visible.

Screen_Shot_2019-01-24_at_9.52.03_am.png

Widget Option 2: Take user-specified amounts from a customer's credit card (useful for taking donations)

This option is very useful if you would like to take donations from your website. You can add a widget on your page which allows users to make payments on your website. It will look something like this:

Screen_Shot_2019-01-24_at_9.59.29_am.png Screen_Shot_2019-01-24_at_10.03.56_am.png 

 

To add the widget to your WordPress website:

  1. Click "Settings → Pay Advantage". Ensure that you have your API username and password entered in.
  2. You can customise the widget with additional options on this page. The description is what will show up on the payment.Screen_Shot_2019-01-24_at_10.09.54_am.png
  3. Press "Save Changes"
  4. Navigate to "Appearance" → Widgets
  5. Add the widget "Pay Advantage - Take Credit Card Payment" anywhere you like (for example in your sidebar). For instructions on how to use Widgets please see this article. You can add an optional Title that will appear above the widget on your page if you would like. Screen_Shot_2019-01-24_at_10.11.04_am.png
  6. You can adjust your settings anytime in "Settings → Pay Advantage"

You should now be able to see the widget on your page wherever the widget area is visible.

Screen_Shot_2019-01-24_at_10.12.39_am.png

Option 3: WooCommerce Integration

One of the most powerful features of the plugin is its integration with WooCommerce, which allows you to take credit card payments (through your Pay Advantage account). This means that your payment system and inventory management software will be synced from the get-go.

Here is an example of how it could look in your website:

Screen_Shot_2018-09-25_at_12.14.22_pm.png

Also, it is incredibly easy to set up! Below are the instructions to get this working in your own site. Once you have API credentials and have downloaded and activated the WordPress Plugin (see steps above) and have WooCommerce installed:

  1. Navigate to "WooCommerce" → "Settings"
  2. Click on the "Payments" tab at the top
  3. Switch the "Enabled" toggle for "Pay Advantage" to "on"
  4. Press "Manage" next to the Pay Advantage row
  5. Enter in your API credentials for your Pay Advantage account
  6. That's it!

Now you can start taking payments straight away. We will manage your payments and you will receive all of your receipts in your Pay Advantage account. It's as simple as that!

 

Have more questions? Submit a request

Comments