- Solutions
- Our Platform
Our Platform
Paydock
Quick Contact
- Developers
Developers
Paydock
Resources
- About
About
Paydock
Newsroom
Contents
WooCommerce merchant manual
Validated Versions
The Paydock WooCommerce Payment Extension has been tested and validated to work with the following versions:
- WooCommerce: 8.3 to 8.8
- PHP: 7.4 to 8.2
Please note, our extension has not been tested for compatibility with any third-party plugins.
Important Information: Paydock has not yet extended testing beyond the versions listed in this section and has no plans to validate the extension against all versions of WooCommerce, PHP or available third-party plugins. We have no knowledge of the correct functioning of the extension with versions outside of those listed above. If you choose to use the extension with an unvalidated version of WooCommerce, PHP, or with any third-party plugins, please be aware that Paydock cannot confirm that the extension will work correctly and Paydock may not be able to provide the support necessary to ensure that the extension is able to function properly.
For the best experience and full support, we recommend using the validated versions specified above.
Install the plugin
Start with installing the Paydock plugin. There are 2 methods available for you:
Installation using the WordPress Directory
Installation by Uploading a ZIP file
Install using the WordPress directory
- Log in to your WordPress dashboard
Open your web browser. Go to the WordPress site and log in with your administrator credentials.
- Navigate the plugin menu
Find and click “Plugins”→ “Add New” from the left sidebar in the dashboard
- Search for Paydock
The “Add Plugins” page has a search bar. Type “Paydock” into this search bar and press Enter.
- Install the plugin
The Paydock plugin is listed in the search results. Click the “Install Now” button next to the plugin. WordPress then
downloads and installs the plugin.
- Activate the plugin
Once the installation is complete, a button appears in place of “Install Now” labelled “Activate”. Click the button to activate Paydock on your site.
Install by uploading a ZIP file
- Download the plugin
Download the Paydock ZIP file. Ensure you know where the downloaded file is saved on your computer. - Log in to your WordPress dashboard
Open your web browser. Navigate to your WordPress site and log in with your administrator credentials.
- Access the plugin menu
Once logged in, navigate to the left sidebar and click “Plugins” followed by “Add New” at the top of the page.
- Upload the plugin
The “Upload Plugin” button is located at the top of the “Add Plugins” page. Click on it to proceed.
-
Click the “Choose File” button and navigate to where you saved the Paydock plugin ZIP file. Select the file and click “Open”.
- Install the plugin
With the file selected, click the “Install Now” button to upload and install the plugin.
- Activate the plugin
After the installation, you will be taken to a new page. Click the “Activate Plugin” button to activate Paydock on your site.
Configure the plugin
- Open the payment methods page
Navigate to the left sidebar and click “WooCommerce” followed by “Settings”, then select the “Payments” tab.
- Open plugin configuration
Press “Manage” to access the configuration page.
The Configuration page displays as follows:
3. Explore the configuration structure
Live connection
Sandbox connection
Widget configuration
Logs
Live connection
Configure the plugin for transactions in a real store environment using your live Paydock keys and payment gateway settings.
Sandbox connection
Set up a test environment with the test keys for safely testing plugin features without real transactions.
Widget configuration
Customise the appearance of the payment widget.
Logs
Manage and view logs of interactions between the plugin and the Paydock API for monitoring and troubleshooting.
Live | Sandbox connection
The “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.
| Field | Data | Purpose |
|---|---|---|
| Connection to Paydock |
Selection out of:
|
Method of connecting to Paydock API. |
| Public Key | public key | This key is used for authentication to ensure secure communication with the Payment Gateway. You must fill it out only if the API and Widget Token has not been entered. |
| Secret Key | secret key | This key is used for authentication to ensure secure communication with the Payment Gateway. You must fill it out only if the API and Widget Token has not been entered. |
| API Access Token | access token | This token authorizes API transactions. Only populate this field if the API Public Key and API Secret Key are not entered. |
| Widget Access Token | widget access token | This token authorizes Widget transactions. Only populate the field if the API Public Key and API Secret Key are not entered. |
| Field | Data | Purpose |
|---|---|---|
| Enable | checkbox | Tick the checkbox to enable “Cards” as a payment option during 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 Paydock. |
| 3DS | Selection out of possible options:
| Enable or disable 3DS. To enable, select either standalone 3DS or in-built 3DS. |
| 3DS service ID | 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:
| When 3DS is enabled, select which 3DS flow to be supported.
|
| Fraud | Selection out of possible options:
| Enable or disable Fraud. To enable, select either standalone Fraud or in-built Fraud. Note:
|
| Fraud service id | id | Provide the Fraud service ID to be used for Fraud checks when enabled. Note: Required for “Standalone Fraud” and “In-built Fraud”. |
| Direct Charge | checkbox | Tick the checkbox if you want the payment to be 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:
| Provide how you prefer the payment source information to be saved. Note: This field is only available when the “Save card” checkbox is ticked. |
Apple Pay
Google Pay
PayPal Smart Button
Afterpay v2
| Field | 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 Paydock. |
| 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. |
Afterpay v1
Zip
| Field | 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 Paydock. |
| 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. Note: This option for APMs is available only for Zip. |
Configure the Widget
-
Select version
- Paydock recommends using the latest version of the Paydock widget by default. However, you can switch to an older version by selecting “Version: custom” and specifying your desired version.
-
Personalise payment method titles and descriptions
- Change the title and/or description based on what you want your customers to see at checkout.
-
Stylise 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 the plugin
-
Click on “Add order.”
- Complete the order details and click the “Create” button.
2. Create a new charge request through the Paydock dashboard.
-
Navigate to the charges page on the Paydock dashboard.
-
Click on the “Add New” tab.
- Complete the charge details, ensuring 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 Paydock” 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 Paydock” status to open the order details.
- Initiate a refund
On the Order details page, find the “Refund” button.
- Click the “Refund” button to begin 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 Paydock.”
- For a partial refund, it will change to “Partially refunded by Paydock.”
Note: You can continue to issue partial refunds until the cumulative refund amount equals the total amount of the original order.
Capture charge
Pre-requisite:
Ensure that the order is in the “Authorised via Paydock” status, which means the funds have been authorised but not yet captured.
-
Select the authorised order
- Identify the order that has been authorised but not charged. These orders are listed with the status “Authorised via Paydock”.
- Click on the specific order number to enter the Order details page.
-
Capture the charge
- Find the “Capture charge” button on the Order details page.
- Click the “Capture charge” button to initiate the charge of the authorized funds.
-
Check the order status update
-
After capturing the charge, the order status automatically updates to “Paid via Paydock”.
-
Cancel charge
Pre-requisite:
The order must be in either the “Authorised via Paydock” or “Paid via Paydock” status to proceed with a cancellation.
Select the Order to Cancel:
- Locate the order you want to cancel by browsing the list or using the search functionality.
- Click on the order number to go to the Order details page.
Initiate Cancellation:
- Find the “Cancel charge” button on the Order details page.
- Click the “Cancel charge” button to start the cancellation process.
Check the order status update
- Upon successful cancellation, the order status changes to “Cancelled via Paydock”.
