Introduction
Briqpay for WooCommerce is a plugin that extends WooCommerce allowing you to accept payments via Briqpay. It replaces the standard WooCommerce checkout page.
Required WordPress/WooCommerce settings
- Make sure that you have enabled pretty permalinks in your WordPress installation. Otherwise callbacks from Briqpay back to your store won’t work and orders will not be updated with the correct order status/information.
- To get the order total to match between WooCommerce and Briqpay you need to configure WooCommerce to display prices with 2 decimals. More information about displaying of prices and how it can cause rounding issues can be found in this article.
Installation
- Download the .zip file you got from us.
- Go to: WordPress Admin > Plugins > Add New and Upload Plugin the file you have downloaded.
- Install Now and Activate.
Setup and Configuration
Once you have installed the plugin you need to configure it in accordance to the steps below
- Go to: WooCommerce > Settings > Payments > Briqpay
- Enable Briqpay by checking the Enable Briqpay payment checkbox.
- Title – Enter the title for the payment method displayed in the checkout and order confirmation emails.
- Description – Enter the description of the payment method displayed in the checkout page.
- Other payment method button text – Customize the Select another payment method button text that is displayed in checkout if using other payment methods than Briqpay. Leave blank to use the default (and translatable) text.
- Enable Credit scoring – Check this box to apply the credit scoring rules to purchase requests sent to Briqpay.
- Enable Max amount – Check this box to apply max amount rules to purchase requests sent to Briqpay
- Enable Order Management – Check this box to enable Briqpay order capture on WooCommerce order completion.
- Test mode – check the Enable test mode checkbox to place the payment gateway in test mode when using test API keys. If not checked the payment method will function in a live production environment.
- Logging – check the Log debug messages to save debug messages to the WooCommerce System Status log
API Credentials
- Production Briqpay API Username – Where you enter the API Username received from Briqpay.
- Production Briqpay API Password – Where you enter the API Password received from Briqpay.
- Test Briqpay API Username – Where you enter the API Test Username received from Briqpay. Used if Test mode is checked above.
- Test Briqpay API Password – Where you enter the API Test Password received from Briqpay. Used if Test mode is checked above.
Order Management
When an order is created in WooCommerce and a reservation number exists in Briqpay’s system, you have the possibility to handle the order in Briqpay directly from WooCommerce. This way you can save time and don’t have to work in both systems simultaneously.
This does however not include cancellations of orders at the moment, which still has to be manually managed in WooCommerce and Briqpay’s system.
Requirements
To get started with order management in Briqpay via your WooCommerce store, you need to check the box to activate the Enable Order Management setting in the payment settings.
Activate an order
- The WooCommerce order status need to be set as Processing.
- Go to the order edit screen by navigate to → WooCommerce → Orders and click on the order you want to edit.
- In the Order details box there is a selectbox named Order status. Change the status to Completed.
- Click the Update button located at the top right on the screen.
- If everything was successful a new order note saying Briqpay reservation was successfully activated is created.
Refund an order
- The WooCommerce order status need to be set as Completed.
- Go to the order edit screen by navigate to → WooCommerce → Orders and click on the order you want to edit.
- In the Order items box, press the Refund button.
- Here you can choose to refund the full sum for an item (1), part of the sum (2) or shipping (3).
If you enter a sum manually (2) you also need to enter the correct tax to refund manually, as opposed to when you refund the full sum for an item in which case the tax is automatically calculated. With shipping (3) you need to enter the amount manually, as well as the tax. Not to be confused with the Refund manually button.
- Press the Refund via Briqpay button.
- If everything was successful a new order note saying Order refunded for xx kr with Briqpay is created.
Currencies
The plugin itself has no limitations regarding currency.
However, please note that there can be limitations in the agreement you have with Briqpay.
When it comes to questions regarding supported currencies you should always talk to your payment provider. The exception is when the plugin in fact do have limitations.
You can read more about this at the Briqpay website.
Compatibility with themes & plugins
- Briqpay uses its own template file for displaying the checkout page and should work with most themes. However, the plugin is only tested with the Storefront theme and we do not guarantee that it will work with other themes. Common situations when errors occur are:
– Themes/plugins with customized template files for WooCommerce checkout page.
– Themes/plugins that modifies the checkout into a multi step checkout.
Krokedil and Briqpay do not offer help with adapting your theme or plugin within regular support.