Guides

osCommerce

Introduction

osCommerce is an open-source e-commerce platform that allows merchants to build an e-commerce store. Add the BillDesk osCommerce plugin to seamlessly accept payments through this store.

Merchant can download the plugin with the following link.

Prerequisites

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

To add the currency as 'Indian rupee':

  • Go to Dashboard → Settings → Localization → Currencies.
  • Click on the New Currency button.
  • Enter the currency details.
  • Click on the 'Set as default' checkbox and click on the Update button.
screencapture-apache-wd-wp-admin-edit-php-2022-11-17-16_25_56.png
  • Once the currency is added, it will be visible in the currency list.

Integration Steps

Installation

  • Click on the Download button to download plugin zip file.
  • Extract the zip file and copy the billdesk.php inside the root directory of osCommerce lib/common/modules/orderPayment/library folder and all files inside the lib folder should be copied into the lib/common/modules/orderPayment/lib folder.

Once the plugin code is placed in respective folders, BillDesk will be available as part of payment modules:

  • Go to Modules → Payment → Online.
  • To integrate BillDesk Payment Integration with the merchant's osCommerce website, click on Install.

  • Once the installation is complete, the BillDesk payment module is available under 'Modules' list.

Configuration

  • Navigate to Modules → Payment → Online Payment Modules.

  • Click on the Edit button.

  • Enter the BillDesk payment integration details.

The merchant would have obtained necessary details like Merchant ID, Merchant Key, etc. from the BillDesk team.

  • Enable BillDesk Module- string - Set as True.

  • 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 Key - string - An encryption key that is used to protect the communication with Payment Gateway APIs.

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

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

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

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

  • Payment Categories - string - This option allows to configure payment categories. Suppose if a merchant only wants to show cards as a payment option, then it can be controlled using this configuration. All allowed payment methods need to be mentioned separated by a comma. Note that since the payment methods name can be dynamic, there is no validation for this input at this moment. Valid payment category codes are as follows:

    1. card - Credit/Debit Card
    2. emi - EMI
    3. nb - Netbanking
    4. upi - UPI
    5. wallets - Wallets
    6. qr - QR Code
    7. gpay - Google Pay

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

  • Payment Zone - If a zone is selected, only enable this payment method for that zone.

  • Sort order of display - Sort order of display. Lowest is displayed first.

  • Child Window - number - Modal redirects the merchant page to bank URLs for processing the payment. “Child window” parameter gives an option to control the window in which OTP 2FA (Two factor authentication) screen will open.

    • True - In this case, a new window will open for the OTP 2FA screen.
    • False - In this case, the OTP 2FA screen will open in the same window.

  • Click on Update.

👍

Success

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

Features

Payment

To make a successful transaction

  • Login or create and account.
  • Go to the store.
  • Add a product in cart and click on Checkout for Purchase.
  • Enter the shipping address and contact information and select a relevant Shipping method.
  • In payment section, select BillDesk and agree to terms of service.
  • Click on Confirm and pay button.
  • Merchant will be redirected to a 'BillDesk modal screen'.
  • On the BillDesk payment options modal screen, merchant logo will appear based on what has been configured in the “Merchant Logo” parameter during configuration.

As a sample, Cards as a payment category is selected.

  • After the transaction is successful, the user will be redirected to the below screen:

Order Listing

Merchant can view the list of orders under Orders/Customers → Orders.

Click on a particular order number to view details.

📘

Note

Merchant will get detailed information about the order and its current status.

Troubleshooting

For osCommerce, plugin specific log file present at lib/Billdesk/logs/osc_billdesk-yyyy-mm-dd.log, where the merchant can check the reason of failure.

Updated 26 days ago