Get started
Customization
Introduction
Avarda Checkout for WooCommerce is a plugin that extends WooCommerce, allowing you to take payments via Avarda.
- The plugin can be downloaded for free here.
- Avarda Checkout is available in Sweden, Norway, Finland and Denmark.
- You need an agreement with Avarda to be able to use this plugin.
- A SSL Certificate is required.
Avarda Checkout support High-Performance Order Storage (HPOS).
Avarda Checkout does not support the Checkout block i WooCommerce.
You can read more about this here.
Required WooCommerce Settings
- Make sure that you have enabled pretty permalinks in your WordPress installation. Otherwise callbacks from Avarda back to your store won’t work and orders will not be updated with the correct order status/information.
- It is recommended to enable guest checkout (Enable guest checkout setting in WooCommerce > Settings > Checkout). If you don’t allow guest checkout you must check both Automatically generate username from customer email and Automatically generate customer password in WooCommerce > Settings > Accounts setting page.
- To get the order total to match between WooCommerce and Avarda 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. Avarda Checkout does not support the Checkout block at this point. You can read more about this here.
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. Avarda Checkout 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
- Go to: WooCommerce → Settings → Payments → Avarda Checkout.
- Enable Avarda Checkout by checking the Enable Avarda Checkout 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 the checkout if using other payment methods than Avarda Checkout. Leave blank to use the default (and translatable) text.
- Checkout flow – Select how Avarda Checkout should be integrated in WooCommerce.
Embedded – the checkout is embedded in the WooCommerce checkout page and partially replaces the checkout form.
Redirect – the customer is redirected to WooCommerce order pay page where the Avarda Checkout is displayed. - Testmode – Check the box if you make purchases using a test account.
- Age validation – Enter an age if you only want to offer purchases from customers older than the specified age. Leave blank or set to 0 to disable age validation.
- Display items – Check this box to enable the display of the order items in the Avarda Checkout. If disabled, the Avarda Checkout will only display the total amount.
- Enable order management – Check this box if you want to enable automatic order management for the Avarda order.
- Debug log – Check this box to log events for debugging.
Read more about logs and level threshold in the Logs settings section below. - Payment gateway icon – Enter an URL to the icon you want to display for the payment method. Use default to display the Avarda logo. Leave blank to not show an icon at all.
- Payment gateway icon width – Specify the max width (in px) of the payment gateway icon.
- Two column checkout layout – Enables a two column checkout.
Shipping
- Integrated Shipping – Select which type of shipping you want to integrate in Avarda Checkout. This will display the shipping methods for the customer inside the Avarda Checkout instead of the WooCommerce order summary.
Chose between None, Partner Shipping and Avarda Shipping Broker.
For example, Partner Shipping could be used to display your WooCommerce shipping methods in Avarda Checkout.
Avarda Shipping Broker could be used to display integrated shipping with for example Ingrid or nShift.
Read more about activation and configuration of Integrated Shipping.
API Credentials
Sweden/Norway/Denmark/Finland
- Client ID – Enter the Client ID, for each country that you have an agreement for, that you receive from Avarda.
- Client Secret – Enter the Client Secret, for each country that you have an agreement for, that you receive from Avarda.
International
If a currency the customer is using does not have their own credentials in Avarda the international credentials will be used instead.
- Client ID – Enter the international Client ID that you receive from Avarda.
- Client Secret – Enter the international Client Secret that you receive from Avarda.
The currency in the store must match the currency configured for the credentials by Avarda. If not, Avarda will not appear in the checkout.
Order Management
When an order is created in WooCommerce and a reservation number exists in Avarda system, you have the possibility to handle the order management in Avarda directly from WooCommerce. This way you can save time and don’t have to work in both systems simultaneously.
Requirements
To get started with order management in Avarda via your WooCommerce store, you need to activate the Enable order management setting in the payment gateway settings.
Cancel 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 Status. Change the status to Cancelled.
- Click the Update button located at the top right on the screen.
- If everything was successful a new order note saying Avarda reservation was successfully cancelled is created.
Manually Cancel an order
You can also manually Activate and Cancel the Avarda order from WooCommerce without changing the order status in WooCommerce.
With this method the WooCommerce order status will remain unchanged after cancelation.
This can be done from the Order actions metabox in the order in WooCommerce.
- In the Order actions metabox, chose the action Cancel Avarda order.
- Click Update.
- If everything was successful a new order note saying Avarda reservation was successfully cancelled is created.
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 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 Avarda reservation was successfully activated is created.
Manually Activate an order
You can also manually Activate and Cancel the Avarda order from WooCommerce without changing the order status in WooCommerce.
With this method the WooCommerce order status will remain unchanged after activation.
This can be done from the Order actions metabox in the order in WooCommerce.
- In the Order actions metabox, chose the action Activate Avarda order.
- Click Update.
- If everything was successful a new order note saying Avarda reservation was successfully activated is created.
Refund an order
Avarda Checkout supports full refunds as well as partial refunds.
- 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 Avarda Checkout button.
- If everything was successful a new order note saying Avarda Checkout order was successfully refunded is created.
Disable and enable order synchronization
By default, order synchronization is always enabled. It is however possible to turn off order synchronization between WooCommerce and Avarda via a setting in the Avarda metabox.
When disabled, you can modify the WooCommerce order in any way (e.g., change order status, modify order lines) without effecting the corresponding Avarda order.
When disabled any changes in either system will have to be done manually. You can find the toggle to turn order synchronization on or off when you expand the Advanced section in the Avarda metabox.
View Avarda order object
In the Avarda metabox you have the possibility to view the current Avarda order in JSON format. This can be useful if you need to troubleshoot and order or are in contact with our, or Avardas, support.
You can find the View Avarda order object button when you expand the Advanced section in the Avarda metabox.
Logs settings
As of version 1.14.0 Avarda Checkout for WooCommerce support log levels in WooCommerce, to allow limiting of the messages logged.
- Go to: WooCommerce → Status → Logs → Settings
- Level threshold – This sets the minimum severity level of logs that will be stored. Lower severity levels will be ignored. None means all logs will be stored.
When you set your level threshold, Warning in the example below, it means that everything above in the list will be logged and everything below will be ignored.
Currencies
The plugin itself has no limitations regarding currency.
However, please note that there can be limitations in the agreement you have with Avarda.
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 Avarda website.
Subscription support
Avarda Checkout is compatible with the WooCommerce Subscriptions extension for handling of recurring payments.
Read more about recurring payments here.
Compatibility with themes & plugins
- Avarda Checkout 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 Avarda do not offer help with adapting your theme or plugin within regular support.