PowerBoard WooCommerce Plugin
This document will guide you on how to install PowerBoard plugin on your WooCommerce store.
WooCommerce
How can I get PowerBoard on my WooCommerce store?
1
Install the PowerBoard WooCommerce plugin
2
Configure the plugin
3
Test & Go-Live
Pre-requisites
- PowerBoard Pre-Prod merchant account if testing in pre-prod.
- PowerBoard Prod merchant account for your prod store.
Please reach out to your CBA contact to obtain your merchant account.
Compatibility
The PowerBoard WooCommerce plugin is compatible with the following versions:
| WooCommerce | Versions |
|---|---|
| WooCommerce | 8.3 to 8.8 |
Installation
Note
It’s recommended that you first install the PowerBoard module in a development WooCommerce environment that is an exact copy of your live store. After you have verified everything is working properly on your development environment, you can safely install the module in your live environment.
Install by uploading the plugin
Step 1. Download the plugin
- Download the PowerBoard ZIP file from our github repo. Ensure you know where the downloaded file is saved on your computer.
Note: When downloading from the github repo, github may zip the plugin. In that case you will need to to unzip the downloaded package and upload the oriiginal plugin (zip package) to your WooComm backend.
Step 2. Log in to your WordPress admin dashboard
- Open your web browser. Go to the WordPress site and log in with your administrator credentials.
Step 3. Navigate to the plugin menu
- Find and click "Plugins" → "Add New Plugin" from the left sidebar in the dashboard.
- The "Add Plugins" page has a search bar. Type "PowerBoard" into this search bar and press Enter.
- Click the "Choose File" button and navigate to where you saved the PowerBoard plugin ZIP file. Select the file and click "Open".
Step 5. Install & Activate the plugin
- With the file selected, click the "Install Now" button to upload and install the plugin.
- After the installation, you will be taken to a new page. Click the "Activate Plugin" button to activate PowerBoard on your site.
Configuration
- Open the payment methods page
- Navigate to the left sidebar and click "WooCommerce" → "Settings" → at the top of the page.
- The new Payment method "PowerBoard" is on the list. Ensure it is enabled. Press “Manage” to access the configuration page.
- Open plugin configuration
- Clicking “Manage” on the previous step takes you to the plugin configuration section.
Understand the config tabs
| Tab | Purpose |
|---|---|
| Live Connection | Configure the plugin for transactions in a real store environment using your live PowerBoard keys and payment gateway settings. |
| Sandbox Connection | Set up a test environment with the test keys for safely testing plugin features without real transactions. Note: PowerBoard plugin the test is performed on the Pre-Prod environment |
| Widget Configuration | Customize the appearance of the payment widget. |
| Logs | Manage and view logs of interactions between the plugin and the PowerBoard API for monitoring and troubleshooting. |
“Live Connection” and “Sandbox Connection” tabs have the same structure.
To configure the plugin for test transactions, select the Sandbox checkbox on top of the “Sandbox Connection” tab. This ensures that all transactions are processed in a sandbox environment, allowing for safe testing without affecting your live operations.
API Credentials
| Setting Name | Data | Purpose |
|---|---|---|
| Connection to PowerBoard | Selection out of: - Public & Secret Keys - Access Token | Method of connecting to PowerBoard API. |
| Public Key | public key | This key is used for authentication to ensure secure communication with the Payment Gateway. You must obtain this key from your merchant portal populate this field. |
| Secret Key | secret key. (Required) | This key is used for authentication to ensure secure communication with the Payment Gateway. You must obtain this key from your merchant portal populate this field. |
| API Access Token | access token | This token authorizes API transactions. Only populate this field if the API Public Key and API Category Field Data Purpose Secret Key are not entered. |
| Widget Access Token | widget access token | This token authorizes Widget transactions. Only populate this field if the API Public Key and API Secret Key are not entered. |
Cards
| Setting Name | Data | Purpose |
|---|---|---|
| Enable | checkbox | Tick the checkbox to enable “Cards” as a payment option in the checkout. |
| Supported card schemes | selection out of available card schemes | Select which Card type scheme logo to display during checkout. |
| Gateway ID | id | Provide the Gateway ID for the respective payment gateway configured from PowerBoard and obtained obtained from PowerBoard Merchant Portal > Services.. |
| 3DS | Selection out of possible options: - disable - standalone 3DS - in-built 3DS | Enable or disable 3DS. To enable, select in-built 3DS. |
| 3DS service ID | gateway id | Provide the 3DS service ID to be used for 3DS checks when enabled. Note: This field is only required when standalone 3DS is enabled |
| 3DS flow | Selection out of possible options: - with vault - with OTT | When 3DS is enabled, select which 3DS flow to be supported. - For Standalone 3DS, charge creation is supported: - with vault - For In-built 3DS, charge creation is supported: - with vault - with OTT |
| Fraud | Selection out of possible options: - disable - standalone - Fraud - in-built Fraud | Enable or disable Fraud. To enable, select either standalone Fraud or in-built Fraud. Note: - “In-built Fraud” is not available when “standalone 3DS” is selected - “Standalone Fraud” is not available when “Inbuilt 3DS with OTT” is enabled |
| Fraud service ID | id | Provide the Fraud service ID to be used for Fraud checks when enabled. Note: Required for “Standalone Fraud” and “In-build Fraud” |
| Direct Charge | checkbox | Tick the checkbox if you want the payment captured as soon as the order is placed. |
| Save card | checkbox | Tick the checkbox to allow your logged-in customer to save their cards during checkout. Note: Inbuilt 3DS flow with OTT. Saved card option is not supported. |
| Save card option | Selection out of possible options: - with vault - customer w/ Gateway ID - customer w/o Gateway ID | Provide how you prefer the payment source information to be saved. Note: This field is only available when the “Save card” checkbox is ticked. |
Wallets
- Apple Pay
- Google Pay
- PayPal Smart Button
Note: Afterpay v2 is currently not supported however merchants can enable Afterpay v1 in their checkout.
Important
You must setup these services in PowerBoard before enabling them in your WooCommerce plugin. Instructions are available:
| Setting Name | Data | Purpose |
|---|---|---|
| Enable | checkbox | Tick the checkbox to enable the required “Wallet” payment methods as a payment option during checkout. |
| Gateway ID | id | Provide the Gateway ID for the respective payment gateway configured from PowerBoard. |
| Fraud | checkbox | Tick the checkbox to enable Fraud. |
| Fraud service ID | id | Provide the Fraud service ID to be used for Fraud checks when enabled. |
| Direct charge | checkbox | Tick the checkbox if you want the payment captured as soon as the order is placed and successful. |
| Pay later | checkbox | Tick the checkbox to enable the Pay later option during checkout. Note: Available only for PayPal Smart Button. |
APMs
- Afterpay v1
- Zip
Important
You must setup these services in PowerBoard before enabling them in your WooCommerce plugin. Instructions are available here.
| Setting Name | Data | Purpose |
|---|---|---|
| Enable | checkbox | Tick the checkbox to enable the required “Alternative Payment Method” as a payment option during checkout. |
| Gateway ID | id | Provide the Gateway ID for the respective payment gateway configured from PowerBoard. |
| Fraud | checkbox | Tick the checkbox to enable Fraud. |
| Fraud service ID | id | Provide the Fraud service ID to be used for Fraud checks when enabled. |
| Direct charge | checkbox | Tick the checkbox if you want the payment captured as soon as the order is placed and successful. |
Configure the Widget
- Select version
PowerBoard recommends using the latest version of the PowerBoard widget by default. - Personalize payment method titles and descriptions
Change the title and/or description based on what you want your customers to see at checkout. - Stylize widget
Change the colour of borders, texts, and more.
Manage your Orders
- Access WooCommerce orders
- Hover over 'WooCommerce' to see a submenu.
- Click on 'Orders' within the submenu.
- This takes you to the main 'Orders' page, where you can view the list of all orders.
Create MOTO Orders
- Add a new order on WooComm admin
- Click on Add Order
- Complete the order details and click the "Create" button and take note order the Order number.
- Create a new charge request through the PowerBoard dashboard
- Navigate to the charges page on the PowerBoard dashboard
- Click on the “Add New” tab
- Complete the charge details, ensuring that the order number obtained from the plugin is provided in the “reference” field.
- Once you have provided the charge and payment details, click the “Create Charge” button.
Refund a charge
Pre-requisite: Ensure that the order is in the "Paid via PowerBoard" status before initiating a refund.
- Select the order
- Find the order you wish to refund by scrolling through the list or using the search functionality.
- Click on the order in “Paid via PowerBoard” status to open the order details.
- Initiate a refund
- On the order details page, look for the 'Refund' button.
- Click the 'Refund' button to start the refund process.
- Enter the refund amount
- In the refund area that appears, enter the amount you wish to refund.
- You can refund the full amount or only a part of the order.
- Process the refund:
- If you are issuing a full refund, the total amount should match the order's total.
- For a partial refund, enter the specific amount you wish to refund.
- After entering the amount, click the 'Refund $xxx manually' button to apply the refund.
- Check the order status
- The order status automatically updates once the refund is processed.
- For a full refund, the order status changes to 'Refunded by PowerBoard.'
- For a partial refund, the order status changes to 'Partially refunded by PowerBoard.'
Note: You can continue to issue partial refunds until the cumulative refund amount equals the total amount of the original order.
Updated 4 months ago