CCBill VirtueMart Module

 

Introduction

The goal of this document is to provide installation and configuration instructions for the CCBill VirtueMart billing module. This document assumes that the reader has a working knowledge of VirtueMart and has already installed the VirtueMart software.

Installation

The CCBill VirtueMart billing module enables easy integration of your CCBill account within the VirtueMart e-commerce platform. Installation involves the following steps:

  • Installing the CCBill payment module for VirtueMart. You can download module files at the CCBill Integration Partners Marketplace.
  • Configuring your CCBill account for use with VirtueMart.
  • Configuring the module with your CCBill account information.

Installing the Extension

The CCBill VirtueMart module is installed via the Joomla Extension Manager:

1. Access the Joomla Admin interface.

2. Expand the Extensions menu and select the Extension Manager option.

3. Open the Upload Package File tab.

4. Select the CCBill VirtueMart zip file and click Upload & Install.

Install the CCBill extention in VirtueMart.

When installation is complete, VMPayment - CCBill will display in the extensions list.

Configuring your CCBill Account

Before using the plugin, it’s necessary to configure a few things in your CCBill account. The following CCBill settings must be correct for the payment module to work correctly.

Enable Dynamic Pricing

Please work with your CCBill Support representative to activate Dynamic Pricing for your account. You can verify that Dynamic Pricing is active at Account Info > Manage the Sub Accounts > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Check if Dynamic Pricing is enabled in the CCBill Admin.

Creating a Salt/Encryption Key

A "salt" is a string of random data used to make your encryption more secure. You must contact CCBill Merchant Support to generate your Salt/Encryption key. Once set, it will be visible under the Advanced section of the Sub Account Admin menu.

It will appear in the Encryption Key field of the Upgrade Security Setup Information section.

Location of Salt Key in the CCBill Admin.

Disabling User Management

Since this account will be used for Dynamic Pricing transactions (not managing user subscriptions), User Management must be disabled.

1. Sign in to the Admin Portal.

2. On the Account Info mega menu, click Sub Account Admin.

3. Open the User Management menu.

4. Click Turn off User Management in the top section.

5. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Turning off the User Management feature in the CCBill Admin.

Creating a New Payment Form

The payment form is the CCBill form that will be displayed to customers after they choose to check out using CCBill. The payment form accepts customer payment information, processes the payment, and returns the customer to your website where a confirmation message is displayed.

CCBill provides two types of billing forms. FlexForms is our newest (and recommended) system, but standard forms are still supported. Please choose a form type and proceed according to the section for Option 1 or Option 2, according to your selection.

Option 1: Creating a New FlexForms Payment Form

To create a FlexForm form with VirtueMart:

1. Ensure All is selected in the top Client Account dropdown menu. FlexForms are not specific to sub accounts, and cannot be managed when a sub account is selected.

2. Navigate to the FlexForms Systems tab in the top menu bar and select FlexForms Payment Links. All existing forms will be displayed in a table.

Create an Approval URL

1. Click the URLs Library button in the upper-right to create a new URL. The Saved URLs Editor dialog displays.

2. Use the fields under Add New to create a new URL with the following properties.

  • URL Name. Enter a meaningful name for this URL (e.g. Payment Success).
  • URL. Under URL, enter the base URL for your VirtueMart store, followed by:
/index.php

For example, if your VirtueMart store is located at http://www.test.com, the Approval URL would be:

http://www.test.com/index.php

3. Click Save to commit your changes. Your new URL displays under Existing List.

A list of existing FlexForm URLs.

4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.

order_pass

  • Under Your Parameter (key), enter: order_pass
  • Under Use this method, select: Merchant Pass-through Parameter
  • In the third column, enter: order_pass
  • Under Action, click the Add button to save this parameter.

order_number

  • Under Your Parameter (key), enter: order_number
  • Under Use this method, select: Merchant Pass-through Parameter
  • In the third column, enter: order_number
  • Under Action, click the Add button to save this parameter.

layout

  • Under Your Parameter (key), enter: layout
  • Under Use this method, select: Merchant Defined Static Parameter
  • In the third column, enter: details
  • Under Action, click the Add button to save this parameter.

option

  • Under Your Parameter (key), enter: option
  • Under Use this method, select: Merchant Defined Static Parameter
  • In the third column, enter: com_virtuemart
  • Under Action, click the Add button to save this parameter.

view

  • Under Your Parameter (key), enter: view
  • Under Use this method, select: Merchant Defined Static Parameter
  • In the third column, enter: orders
  • Under Action, click the Add button to save this parameter.

Your saved parameters display under Currently Defined Name/Value Pairs.

VirtueMart passthrough variables in CCBill FlexForms admin.

5. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.

6. Click Promote under the Actions column. Your URL is now live.

7. Close the Saved URLs editor to return to the main FlexForms menu.

Create a New FlexForm

1. Click the Add New button in the upper left to create a new form.

2. The New Form dialog is displayed:

  • Payment Flow Name. At the top, enter a name for the new payment flow (this will be different than the form name, as a single form can be used in multiple flows).
  • Form Name. Under Form Name, enter a name for the form.
  • Dynamic Pricing. Under Pricing, check the box to enable dynamic pricing.
  • Layout. Select your desired layout, and save the form.
  • Edit the Flow. Click the arrow button to the left of your new flow to view the details. Under the green Approve arrow, click the square to modify the action.
  • Approval URL. In the left menu, select A URL > Select a Saved URL and select the URL your created earlier (e.g. Payment Success).
  • Redirect Time. Select a redirect time of 1 second using the slider at the bottom and save the form.

3. Promote to Live. Click the Promote to Live button to enable your new form to accept payments.

4. Note the Flex ID. Make note of the Flex ID; this value will be entered into the form name when completing the configuration in DatingPro.

Continue to the Background Post for VirtueMart section of this document.

Option 2: Creating a New Standard Payment Form

To create a billing form for use with VirtueMart:

1. Sign into the Admin Portal, and navigate to the Form Admin. All existing forms will be displayed in a table.

2. Click Create New Form in the left menu to create your new form.

3. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)

4. Select Standard under Form Type, unless you intend to customize your form.

Steps to create new standard form in the CCBill admin.

5. Choose a layout and click Submit at the bottom of the page.

Your new form has been created and is visible in the table under View All Forms. In this example, our new form is named 201cc.

A list of avilable from in the CCBill Admin.

Configuring the New Standard Billing Form

1. Click the title of the newly-created form to edit it.

2. Select Basic from the left menu.

3. Set the following options:

FIELD NAMEVALUE
Site NameEnter the URL of your VirtueMart store.
Approval URLhttp://www.yourvirtuemartstore.com/index.php?layout=details&view=orders&option=com_virtuemart&charset=utf-8&order_number=%%order_number%%&order_pass=%%order_pass%%
Denial URLhttp://www.yourvirtuemartstore.com/index.php?option=com_virtuemart&view=cart
Redirect TimeSelect an approval redirect time of 3 seconds, and a denial redirect time of None.

Background Post for VirtueMart

In your CCBill admin interface select a sub account the purchases will be made on and navigate to Account Info -> Sub Account Admin and select Advanced from the left menu.

Notice the top section titled Background Post Information. We will be modifying the Approval Post URL and Denial Post URL fields.

Approval Post URLhttp://www.yourvirtuemartstore.com/index.php?option=com_virtuemart&view=pluginresponse&task=pluginnotification&tmpl=component
Denial Post URLhttp://www.yourvirtuemartstore.com/index.php?option=com_virtuemart&view=pluginresponse&task=pluginnotification&tmpl=component

Your CCBill account is now configured. In your CCBill Admin interface, navigate to Sub Account Admin and ensure the displayed information is correct.

Configuration - VirtueMart

After the extension has been installed, a payment method must be created. Select Components > VirtueMart > Payment Methods from the top menu. Click the New button at the top to create a new payment method.

Configure your payment method as shown.

FIELD NAMEVALUE
Payment NameCCBill
Sef Aliasccbill
PublishedYes
Payment DescriptionPay with your credit card with CCBill
Payment MethodVMPayment - CCBill
Shopper GroupAvailable for all
List Order1

CCBill Options

Next, click the Configuration tab and enter your CCBill account information.

OPTIONDESCRIPTION
Client Account NumberEnter your CCBill client account number.
Client SubAccount NumberEnter your CCBill client sub-account number.
Form NameEnter the name of the form created during CCBill account configuration, or FlexForm ID if using FlexForms.
Is Flex FormSelect “Yes” if using FlexForms.
CurrencySelect the billing currency. Ensure this selection matches the selected store currency.
SaltEnter your salt/encryption key obtained during CCBill configuration.
Min Amount and Max AmountLeave these fields blank.
Cost Per Transaction and Cost Percent TotalEnter zero (0) for both of these fields.
Configuration fields for CCBill VirtueMart plugin.

Click Save at the bottom of the CCBill configuration section.

You are now ready to process payments via CCBill! Please conduct a few test transactions (using test data provided by CCBill) to ensure proper operation before enabling live billing mode in your CCBill account.