Introduction

Introduction

Briqpay for WooCommerce is a plugin that extends WooCommerce allowing you to accept payments via Briqpay. It replaces the standard WooCommerce checkout page.

Briqpay for WooCommerce does not support the Checkout block i WooCommerce.
You can read more about this here.


Sign up with Briqpay


You need an agreement with Briqpay to be able to use this plugin.


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.
  • Your checkout page must use the Classic Shortcode block. Briqpay for WooCommerce does not support the Checkout block at this point. You can read more about this here.

Installation


  1. Download the .zip file you got from us.
  2. Go to: WordPress Admin > Plugins > Add New and Upload Plugin the file you have downloaded.
  3. Install Now and Activate.

Setup and Configuration


Before you get started you need to make sure you are using the checkout shortcode on your set Checkout Page.
The Checkout block is the default for new WooCommerce installations as of version 8.3. Briqpay for WooCommerce does not yet support this.

Go to Pages → your set Checkout Page and transform the Checkout block to the Classic Shortcode block.

Basic settings

Once you have installed the plugin you need to configure it in accordance to the steps below

  1. Go to: WooCommerce > Settings > Payments > Briqpay
  2. Enable Briqpay by checking the Enable Briqpay payment checkbox.
  3. Title – Enter the title for the payment method displayed in the checkout and order confirmation emails.
  4. Description – Enter the description of the payment method displayed in the checkout page.
  5. 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.
  6. Enable Credit scoring – Check this box to apply the credit scoring rules to purchase requests sent to Briqpay.
  7. Enable Max amount – Check this box to apply max amount rules to purchase requests sent to Briqpay
  8. Enable Order Management – Check this box to enable Briqpay order capture on WooCommerce order completion.
  9. 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.
  10. Logging – check the Log debug messages to save debug messages to the WooCommerce System Status log

API Credentials

  1. Production Briqpay API Username – Where you enter the API Username received from Briqpay.
  2. Production Briqpay API Password – Where you enter the API Password received from Briqpay.
  3. Test Briqpay API Username – Where you enter the API Test Username received from Briqpay. Used if Test mode is checked above.
  4. 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

  1. The WooCommerce order status need to be set as Processing.
  2. Go to the order edit screen by navigate to → WooCommerce → Orders and click on the order you want to edit.
  3. In the Order details box there is a selectbox named Order status. Change the status to Completed.
  4. Click the Update button located at the top right on the screen.
  5. If everything was successful a new order note saying Briqpay reservation was successfully activated is created.

Refund an order

  1. The WooCommerce order status need to be set as Completed.
  2. Go to the order edit screen by navigate to → WooCommerce → Orders and click on the order you want to edit.
  3. In the Order items box, press the Refund button.
  1. 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.
  1. Press the Refund via Briqpay button.
  2. If everything was successful a new order note saying Order refunded for xx kr with Briqpay is created.

Manually adding an order / Hosted payment page


Briqpay supports the WooCommerce standard functionality to Manually Adding an Order from the WooCommerce admin.

This can also be referred to as “Pay for order” (or “Order pay”) and is a feature that allows you to manually add an order for a new, or returning, customer. This is useful if you accept phone orders, or for some other reason need to create an order with items, coupons and/or fees manually.

With Briqpay the merchant can set the payment method to Briqpay and create a Hosted payment page (HPP) for the customer to visit and pay for the order.

1. Add order

Go to the order screen by navigating to WooCommerce → Orders and then click the Add order button at the top.

In this example we are adding the products first and the customer last. You can do these steps in the order of your chosing, as long as they are done before you create the order.

2. Add products

  1. In the Add new order view, click the Add item(s) button to access the Add product(s) button.
  1. Search for the product(s) you want to include in the order and then click Add when you are done.

3. Add shipping

  1. Click the Add item(s) button to access the Add shipping button.
  1. Click the pen to edit and enter your shipping cost.
  1. When you are done with adding products and shipping, click Recalculate to retreive the correct VAT information for the order.

4. Add billing

  1. Click the pen to enter billing information.
  1. Here you need to enter either Email address or Phone and set the Payment method to Briqpay. These are the required fields.
  1. Click Create in the Order actions metabox to create the order.

5. Create hosted payment page

  1. Select if/how you want to create a hosted payment page in the dropdown in the Briqpay metabox. Choose between Do not create, Send sms to billing phone and Send to billing email.
    Note that the Briqpay metabox is located in the same column as the the Order actions metabox. It can be located further down, depending on your setup.
  1. Click Update in the Order actions metabox to create the Hosted payment page.
  1. An email or a text/sms has now been sent to the customer with a link to the Hosted payment page. The message Hosted payment page created with Briqpay along with the link has also been added to the Order notes.

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.