Introduction

Add the WooCommerce plugin to any WordPress site and set up a new store in minutes. Start accepting payments seamlessly on your website through the BillDesk WooCommerce plugin.

You can download the plugin with the following link.

Prerequisites

Ensure that you have downloaded, installed, and configured:

• WooCommerce version 9.6.0
• PHP version 8.2

Dependency:

• Region: Set Country/State to India - Maharashtra in WooCommerce → General → Store Address
• Currency: Set Currency to Indian Rupee in WooCommerce → General → Currency options
• Time zone: From Settings menu of WordPress, select sub-menu General and set the time zone as Kolkata.

Integration Steps

Installation and Activation

Follow the steps below to install and activate the BillDesk WooCommerce plugin.

Installation

The plugin can be installed in two ways:

• Uploading the plugin from the admin panel:

  • In Plugins→ Add New→ Add Plugins→ Upload Plugin
  • Choose the WooCommerce plugin file and click Install Now
  

• Manually installing the plugin in WordPress:

  • Extract the shared plugin archive file and copy it to wp-content/plugins/ folder within the WordPress deployment.

Activation

• Once the installation is complete, click on Activate Plugin

• Installation & Activation is Successful!

Plugin Configuration

After the plugin is activated, you will need to configure the plugin to start accepting payments via BillDesk.

1. Under the WooCommerce tab in the left menu, click on Settings to configure the plugin.

2. Set currency option as Indian currency (INR) and click on Save changes.

3. Click on the Payments tab and enable BillDesk . Click on Save changes.

4. Click on the Manage button of BillDesk Payment Method.

Ensure that you have obtained the necessary details like Merchant ID, Merchant Key etc. from BillDesk. The configuration page will be as shown below:

• Title - string - The name displayed on the payment information section of order details.

• Merchant Id - string - This is the unique ID created by BillDesk to identify the merchant.

• Client Id - string - A client ID shared by BillDesk for accessing the Payment Gateway APIs.

• Key ID - string - The unique identifier of the public key shared by BillDesk

• Encryption Password - string - An encryption key that is used to protect the communication with Payment Gateway APIs.

• Signing Password - string - A signing key that is used to protect the communication with Payment Gateway APIs.

• Item Code - string - Item Code as shared by the BillDesk team.

• Merchant Logo - string - A URL or Base64 encoded logo that will be visible on the payment dialog.

• Payment Category - string - You can configure Allowed Payment categories at the BillDesk backend. This ensures that you will display only the configured payment categories enabled for them. However, this option also allows you to override the payment category configuration.

  For example, if you want to show cards as the only payment option, you can configure it using this setting. You must mention all allowed payment methods as comma-separated values.

  Note: Payment methods can have dynamic names. The valid payment category codes are as follows:
  Allowed values: [card, emi, nb, upi, wallets, qr, gpay].

• Retry Count - number - Controls the number of payment re-attempts that should be allowed to users on failed payment.

• Child Window - number - Enables or disables the child window.

  • True/Enabled - If it enabled, the modal opens the bank's page for processing in another window.
  
  • False/Disable - If it disabled, the modal redirects the merchant page to bank URLs for processing instead of opening them in another window.
  

• Environment - string - Enables switching between the UAT or Production environments. Depending on this configuration, the plugin will connect to the UAT or production URLs.

• TEST PG CONNECTIVITY - Confirm the successful configuration by clicking on 'Test PG Connectivity'. If the configuration was not successful, check Troubleshooting for error code analysis.

4. Click Save Changes.

👍

Success

At this stage, the BillDesk extension is fully configured. You can now accept payments via the BillDesk payment integration.

Features

Payment

Placing an Order

Following are the steps to place an order on your WooCommerce website.

Product Page

• Click on Add to Cart

Checkout Page

• Click on Place order.

• Complete the payment using BillDesk.

• After payment completion, a confirmation message is displayed.

The user flow is shown in the following screenshots:

Refund

You can follow the steps given below to process a refund. You can also process a partial refund with the WooCommerce plugin.

Initiating a Refund

1. In WooCommerce → Orders, select an order with either "Completed" or "Processing" status.

2. Click on the Refund button.

3. Enter the refund amount and click on Refund via BillDesk.

4. Click on OK to confirm the refund processing.

5. The refund will be processed successfully

Order Listing

You can view the Order History in the WooCommerce → Orders tab.

Check Order Status

1. Click on an order to view its details.

📘

Note

You will get detailed information about the transactions and their current status.

Multi-Currency Converter (MCC) Flow

The MCC flow enables merchants to accept payment in supported international currencies.

BillDesk currently supports the following currencies for international transactions:

Note: BillDesk’s WooCommerce plugin supports ONLY one currency at a time.

Please contact your BillDesk Relationship manager to set up the required currency option prior to initiating the integration

Note: MCC transactions are only supported through Card payment method.

Configuration

Setting up default currency:

• Go to WooCommerce -> Setting -> General -> Currency, set Currency as desired currency from supported currency list.

• Go to Payments tab to verify the configuration.

• Click on Test PG connectivity on BillDesk plugin’s configuration page to confirm the configuration.

  

Payment

• Check the website to confirm that the default currency, that has been enabled, is visible on the store.

• Proceed to checkout

• The selected international currency will reflect on the BillDesk Payment Page.

• Use an international card and complete the payment. Order confirmation with order details will be displayed on successful payment.

Troubleshooting

For Woo-commerce, there is a plugin-specific log file present at logs/woocommerce_billdesk-yyyy-mm-dd.log, where the merchant can check the reason of failure.

To confirm that PG connection is established, go to the Configuration page and click on TEST PG CONNECTIVITY.

Case 1: PG connectivity is successful.

Case 2: PG connectivity is unsuccessful.

If an error occurs during the connection, please refer to the following table:

Errors pertaining to Refunds:

If an error occurs during a refund, an error message will be displayed on the dashboard under the Order Notes section:

For further queries, please connect with your BillDesk assigned RM.

Errors pertaining to Multi-Currency Converter (MCC) payments:

Usage of any other currency apart from Indian Rupees (INR), United States Dollar (USD), Pound Sterling (GBP), Euro (EUR), UAE Dirham (AED) as default currency on the WooCommerce setup would cause the following error:

Please select one of the supported currencies to resolve this error: