WooCommerce is a popular plugin for WordPress that allows you to turn your WordPress website into a fully functional online store. It provides essential features for e-commerce such as product listing, shopping cart functionality, secure payments, order management, and more. With WooCommerce, you can sell physical or digital products, manage inventory, set up shipping options, and customize your store's design to fit your brand. It's widely used for its flexibility, scalability, and ease of use, making it a top choice for individuals and businesses looking to set up an online store quickly and efficiently.

WooCommerce supports many payment methods. Paybyrd has a WooCommerce extension plugin that provides integration with its payment methods through a simple and quick installation.

Installing Paybyrd's WooCommerce plugin extension

If you have a shop configured in WooCommerce, you can follow the steps below to install Paybyrd's payment methods into it as an extension.

Pre-requisites

1. WooCommerce plugin previously installed and configured in your WordPress website,
2. A Paybyrd customer account configured with Test and Live API Keys.

Important note

If you are considering to test Paybyrd's plugin in a self-hosted or local environment using WordPress, remember that you need your WordPress server to have a public exposed URL. This is needed because Paybyrd's payment methods have asynchronous Webhook calls to inform WooCommerce about updates in an order. If your WordPress website does not have a public available API, your orders will not have their status updated when the customer finishes its payment process.

Installation

1. Go to the administration page of your WordPress website, in the “Plugins” section. Click the “Add New Plugin” button, then search for “Paybyrd”. Click “Install Now”, wait for the installation, then click “Activate”.

   

2. Go to the “WooCommerce” menu on the left side of the administration page, then click “Settings” to go to the WooCommerce settings page. Go to the Payments tab. If Paybyrd plugin was correctly installed and activated, it should be listed as a Payment Method in the list. Make sure it is enabled, then click “Manage” button.

   

3. In this form, there are some key fields to be filled.

   

• Title and Description can be changed if you want Paybyrd’s payment method to be described differently than the default.
• Paid order status has two options:
  • Processing: when an order is paid at Gateway, it changes its status as processing in the WooCommerce. This is ideal for products or services having more steps to do to finish the purchase process, like products that needs shipping.
  • Completed: when an order is paid at Gateway, it is also completed in the WooCommerce.
• Test Mode should be enabled if the merchant wants to use simulated payments for testing purposes. When enabling this mode, the Test Private Key will be used to make payments.
• Test Private Key and Live Private Key are the keys that should be informed to the merchant when it finishes its onboarding process at Paybyrd. You should place them in the form to be able to make payments.
• Webhook ID and Webhook Test ID are read-only and are automatically filled when you fill the private keys and click “Save Changes” button.
• Hosted Form Size can be used to set how the Paybyrd’s hosted form will be placed at the screen when the client needs to start the payment process.
  • Full: makes the hosted form fill all the screen, hiding your shop page checkout screen in the process.
  • Half: makes the hosted form appears as a modal dialog in your page, in front of the checkout screen.
• A set of customization fields for the Hosted Form are located right below the "Hosted Form Size" field. They are optional and can be used to change display options like font and background color of the Hosted Form.
• Generate Webhook should not be checked by default. You should only check this field if you already saved your configurations and for some reason the "Webhook ID" and "Webhook Test ID" are still not filled, or if you are experiencing problems with your actual Webhooks. This option forces Paybyrd Gateway to generate new Webhooks and set their ID’s in the Webhook ID fields.

4. When you are done configuring this form, you can click "Save changes" button. Now you should be ready to use Paybyrd’s WooCommerce plugin extension.

Known issues

WooCommerce checkout page block based layout

Paybyrd’s WooCommerce plugin extension does not support block checkout layout. If you are using it, Paybyrd will not appear as a payment method in the checkout page. You will need to change the checkout section to use the classic checkout mode in the Checkout page. To do it, follow the steps below.

1. In your WordPress administration page, find your checkout page in the “Pages” menu and click in “Edit” link.

   

2. If you are using the block style checkout, a warning may appear at the right panel of the edit page. You can just click “Switch to classic layout” and then update your checkout page by clicking the “Update” button. Paybyrd should now appear as a payment option in your checkout page.