Introduction

Magento helps merchants set up a new user-friendly store in minutes. Add the BillDesk Magento plugin to start accepting seamless payments on this store.

Merchants can download the plugin with the following link.

Prerequisites

Ensure that the merchant has downloaded, installed, and activated:

• PHP version 8.1 and higher and MYQSL v8.0. and higher
• Latest Magento v2.4.6 or any of older version 2.4.x, 2.3.x

Integration Steps

Merchant can integrate the BillDesk Magento plugin with the following steps:

Installation

The plugin can be installed in two ways:

1. Add Payment method using composer

Execute this command for install our package:

composer require billdesk/magento

2. Manually install the plugin

Download the shared file and copy and paste it into the app/code/Magento folder.

After installation is complete, run the below given command in the Magento root directory:

● php bin/magento module:enable Magento_BillDesk.
● php bin/magento setup:upgrade.
● php bin/magento cache:clean.
● php bin/magento cache:flush.

Configuration

Adding Merchant Configuration Details

1. In Stores → Configuration→ General → Currency Setup, select the currency as INR.
2. In Stores → Configuration → Sales → Payment Methods, select BillDesk as a payment method.
3. Enter all merchant configuration details and save changes. The merchant would have obtained the necessary details like Merchant ID, Merchant Key, etc. from BillDesk. The configuration page looks as 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.

• 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.

• 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

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

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

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

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

  For example, if a merchant wants to show cards as the only payment option, they can configure it using this setting. The merchant 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.

• New Order Status - string - Set as Processing.

• Payment from Applicable Countries - string- From which country the payment is applicable (All countries or a specific country).

• Payment from Specific Countries - string- Allow payments from specific countries (select option from list).

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

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

• Sort Order - string - Payment method order position on the payment page (Integer value).

• 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 configured completely. Merchant will be able to pay via the BillDesk Payment Integration.

Features

BillDesk Magento plugin comes with some exclusive features:

Payment

Accepting Payments - User flow

Customers can initiate payments via BillDesk by clicking the Pay with BillDesk button. After completing the payment, they will be redirected to the Success page.

The user flow is depicted in the screenshots below:

Refund

Merchant can create a process for managing refunds by following the steps in the link below:

Refunds

Order Listing

1. Click Sales → Orders to view the complete order history available from the plugin.

📘

Note

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

2. Click Sales → Invoices to view the invoices generated for the orders.

Troubleshooting

Magento plugin logs are maintained in var/log/BillDesk/magento_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: