Configuration

This guide will show you how to configure the PowerBoard WooCommerce plugin.

Configure the plugin

  1. Open the payment methods page by navigating to the left sidebar and click WooCommerce > Settings > Payments at the top of the page.

  2. Observe that the new PowerBoard Payment is on the list of available payment methods. Ensure it is enabled. Press Manage to access the configuration page.

Understand the config tabs

TabPurpose
EnvironmentThe Environment the Plugin will be configured too. Preproduction for testing, Production for the live environment.
API Access TokenYour API Access Token. This token is used to securely authenticate your payment operations. It is additionally used to retrieve the values for the Checkout Template ID fields.
VersionThe Version of the Checkout template you will be using. This can be found in the PowerBoard dashboard.
Configuration Template IDThe ID of the Checkout configuration template you will be using. This can be found in the PowerBoard dashboard.
Customisation Template IDAn optional ID of the Checkout customisation template. This can be found in the PowerBoard dashboard.
  1. Configure and create your Checkout Template in the PowerBoard portal.

    1. Use the PowerBoard dashboard to create your API Access token

      1. Navigate to Access Tokens link in the navigation dropdown
      2. Click the Create New button
      3. Select the following permissions:
        • checkouts:create-intent
        • checkouts:search
        • checkouts:get
        • checkouts:get-versions
        • checkouts-templates:get
        • checkouts-templates:search
        • checkouts-templates:create
        • checkouts-templates:update
        • checkouts-templates:get-schemas
        • charges:Refund Charge
        • charges: Search Charge
      4. Click Save. Ensure to save the Access token as you will not be able to access it.
    2. Setup and create your Checkout Templates

      1. Navigate to 'Checkout' in the navigation section

      2. Select ' Create New'

      3. From the 'Select Template Options' you will get the choice of

        1. Customisation - (Template designed specifically for customising the look and feel of your checkout experience)
        2. Configuration - (Templated designed specifically for selecting what workflows/payment services will be included in your checkout experience)
        3. Configuration & Customisation - (Allows you to create the 2 above templates simultaneously)
          Select the template that you wish, for a first-time setup, we recommend using the Configuration & Customisation option.
      4. On the next step, you will get the option to label your templates, we recommend that you keep these unique and call out if the template is for configuration or customisation. On configuration you will also get the option to select which version of the configuration template you want to create.

      5. After selecting your API version this will bring up a list of services, for the service you wish to enable select a transaction flow associated with the service you wish to enable and select the Service ID from the available dropdown. You can see a list of all your services in the 'Services' screen

      6. Once you have selected your workflows and Service ID's associated with each service, click 'Save and Next' (You will also have the ability to update an existing configuration template once it has been created)

      7. You will need to label your customisation template, similar to Step 5, we recommend you keep the label for your configuration template unique and identify that it is a Configuration Template.

      8. You will have the ability to customise the look and feel of your Checkout Widget via the following fields:

        1. Background Colour
        2. Border Colour
        3. Text Colour
        4. Button Colour
        5. Font Family
        6. Font Size
      9. Apply and customization settings and click 'Save' (You will also have the ability to update an existing customisation template once it has been created)

      10. You will now see the templates you just created appear in your Templates list with an associated ID which can be used in your integration.

      11. If you wish to preview the templates that you have created, you can select the 'Preview' option on the Checkout page which will give you the ability to add some configuration data to render the widget within the Merchant Dashboard. (Note: Preview option is only currently available in the PreProduction environment)

      12. Enter information into the provided fields and select the Configuration and Customisation templates you have just created. Once the information has been entered, hit 'Create' and this will render the widget into the 'Preview' column.

  2. Add your Access token in the Plugin configuration and press Save. This will populate the configuration and customisation templates in the plugin.

  3. Configure the version of checkout feature you would like to integrate with, i.e. version 1

  4. Choose the configuration template id of Checkout you created in the PowerBoard dashboard.

  5. Choose the customisation template id of Checkout you created in the PowerBoard dashboard.

  6. Click Save to finalise the plugin setup.