Loading...
 


WooCommerce


This section provides installation and configuration instructions for the CCBill WooCommerce billing module. You should have a working knowledge of WordPress and have already installed WooCommerce for WordPress.

Installation

The CCBill WooCommerce billing module enables easy integration of your CCBill account within the WooCommerce ecommerce platform for Wordpress. Installation involves the following steps:

  • Installing the CCBill payment module for WooCommerce.
  • Configuring your CCBill account for use with WooCommerce.
  • Configuring the module with your CCBill account information.

Installation Options

The CCBill WooCommerce module can be installed either by searching for the hosted WordPress plugin, or by uploading the plugin downloaded from the CCBill website. For more information on installing WordPress plugins visit http://codex.wordpress.org/Managing_Plugins.

Installing via WordPress Plugin Directory

From the WordPress administration menu, navigate to Plugins. Type “CCBill” into the text field and click Search Plugins. Locate the official CCBill plugin for WooCommerce from the search results and click the Install Now link next to the module title.

Wordpress Plugin WooComerce

Installing via File Upload

From the WordPress administration menu, navigate to Plugins and select Upload from the top menu. Click the Choose File button and select the .zip file downloaded from the CCBill website. Once the file is selected, click Install Now to complete the installation process.

Installing Via File Upload

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

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 > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Enabling Dynamic Pricing

Creating a Salt / Encryption Key

A "salt" is a string of random data used to make your encryption more secure. CCBill Merchant Support will generate your Salt/Encryption Key. Once set, it will be visible at Sub Account Admin > Advanced. It will appear in the Encryption Key field of the Upgrade Security Setup Information section.

Creating A Salt

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 megamenu, click Sub Account Admin, then User Management on the left menu.
  3. Select Turn off User Management in the top section.
  4. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Disabling User Management

Create 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 WooCommerce store where a confirmation message is displayed.

 Important

CCBill provides two types of payment forms. FlexForms is our newest (and recommended) system, but standard forms are still supported. Please select a form type to use with WooCommerce and proceed following the instructions for Option 1 or Option 2, according to your selection.

Option 1: Creating a New FlexForms Payment Form

Note: Skip this section if using standard forms.

To set up FlexForms for use with WooCommerce:
  1. Ensure All is selected in the top Client Account drop-down 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 WooCommerce store, followed by:

    /?wc-api=WC_Gateway_CCBill&Action=CheckoutSuccess
    For example, if your WooCommerce store is located at http://www.test.com, the Approval URL would be:

    http://www.test.com/?wc-api=WC_Gateway_CCBill&Action=CheckoutSuccess

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

    Saved URLs
  4. Add Name/Value Pairs.
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • Under Your Parameter (key), enter: wc_orderid
    • Under Use this method, select: Merchant Pass-through Parameter
    • In the third column, enter: wc_orderid
    • Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.

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

  5. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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 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 WooCommerce.
Continue to the Background Post for WooCommerce section of this document.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.
Save New Form
  1. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)
  2. Select Standard under Form Type, unless you intend to customize your form.
  3. Select the desired 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. Be sure to note the name of your new form, as it will be required in the WooCommerce configuration section.

Form Library.jpg

Configuring Your CCBill Account

Note: Skip this section if using FlexForms.

  1. Click the title of the newly-created form to edit it.
  2. Select Basic from the left menu.
  3. Set the following options:
Site Name Enter the URL of your WooCommerce store
Approval URL http://www.yourwoocommercestore.com/?wc-api=WC_Gateway_CCBill&Action=CheckoutSuccess
Denial URL http://www.yourwoocommercestore.com/?wc-api=WC_Gateway_CCBill&Action=CheckoutFailure
Redirect Time Select an approval redirect time of 3 seconds, and a denial redirect time of Instant.

Background Post for WooCommerce

While still in the Sub Account Admin section, 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.

URL Type url
Approval Post URL http://www.yourwoocommercestore.com/?wc-api=WC_Gateway_CCBill&Action=Approval_Post
Denial Post URL http://www.yourwoocommercestore.com/?wc-api=WC_Gateway_CCBill&Action=Denial_Post

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

Configuration - WooCommerce

General Options

In your WordPress admin interface, navigate to WooCommerce and select General from the top menu.

CCBill Options

In your WordPress admin interface, navigate to WooCommerce and select Checkout from the top menu, then select CCBill from the top submenu.

Field Value
Enable CCBill Check the top box to enable payments with CCBill standard.
Title Under Title, enter CCBill.
Description Enter a descriptive message to your customers. “Pay with your credit card via CCBill,” for example.
Client Account Number Enter your CCBill client account number.
Client SubAccount Number Enter your CCBill client sub-account number.
Form Name Enter the name of the form created during CCBill account configuration.
Flex Form Check this box if using FlexForms.
Currency Select the billing currency. Ensure this selection matches the selection made in the General section of the WooCommerce administration menu.
Salt Enter your salt / encryption key obtained during CCBill configuration.

Woocommerce
Under Currency Options, select the default currency you want displayed to your buyers. CCBill currently supports the following currencies:

Currency Options
US Dollar (USD)
Euro (EUR)
Australian Dollar (AUD)
Canadian Dollar (CAD)
Great Britain Pounds Sterling (GBP)
Japanese Yen (JPY)

Click Save Changes 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.

 Note

If you use these features on a WordPress installation and iThemes Security plugin, you may encounter issues receiving posts from CCBill. Follow these steps to resolve the issue:

  1. Log into the WordPress website.
  2. Click on Security Settings.
  3. Click on Banned Users.
  4. Uncheck the Enable HackRepair.com's blacklist feature.



OsCommerce


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

Installation involves the following steps:

  1. Installing the CCBill payment module for osCommerce.
  2. Configuring your CCBill account for use with osCommerce.
  3. Configuring the module with your CCBill account information.

Installation

The CCBill osCommerce module is installed by uploading the plugin code downloaded from the CCBill website into the corresponding folders in your osCommerce installation. There are five (5) files which must be copied:

  • /ext/modules/payment/ccbill/ccbill_post_handler.php
  • /ext/modules/payment/ccbill/ccbill_process_success.php
  • /includes/languages/english/modules/payment/ccbill.php
  • /includes/modules/payment/ccbill.php
  • /ccbill_post_handler.php

 Important

Before installation, if you have the old version of the CCBill payment gateway, remove it from the osCommerce admin, then upload the new code.

  1. In the left menu of your osCommerce admin interface, select Modules > Payment.

    OSCommerce Payment
  2. Click Install Module in the upper-right.

    OSCommerce Install Module
  3. Select CCBill Payments from the list and click Install Module.

    OSCommerce Modules Page
  4. Once the module has been installed successfully, you will be redirected to Modules of the Payment section of the admin interface, with the new CCBill module selected.

Configuring your CCBill Account

Before using the plugin, it’s necessary to configure a few things in your CCBill account. Please ensure that CCBill settings are correct, or the payment module will not work.

Dynamic Pricing

Please work with your CCBill support representative to activate “Dynamic Pricing” for your account. You can verify that dynamic pricing is active by selecting Feature Summary under the Account Info tab of your Admin Portal. Your Dynamic pricing status appears at the bottom of the Billing Tools section.

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.

Creating A Salt

Disabling User Management

Since this account will be used for dynamic pricing transactions rather than managing user subscription, user management must be disabled.

Disabling User Management
  1. Sign in to the Admin Portal.
  2. Click the Account Info mega menu, click Sub Account Admin, then click User Management from the left menu.
  3. Under Username Settings select Do Not Collect Usernames and Passwords.

Creating a New Payment Form

Payment forms are displayed to customers after they choose to check out. The payment form accepts customer payment information, processes the payment, and returns the customer to your osCommerce store where a confirmation message is displayed.

 Important

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

Note: Skip this section if using standard forms.

To set up FlexForms for use with osCommerce:

  1. Ensure All is selected in the top Client Account drop-down 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 osCommerce store, followed by:

    /ext/modules/payment/ccbill/ccbill_post_handler.php?Action=Approval_Post
    For example, if your osCommerce store is located at http://www.test.com, the Approval URL would be:

    http://www.test.com/ext/modules/payment/ccbill/ccbill_post_handler.php?Action=Approval_Post
  3. Click Save to commit your changes. Your new URL displays under Existing List.

    Saved URLs
  4. Add Name/Value Pairs.
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • Under Your Parameter (key), enter: zc_orderid
    • Under Use this method, select: Merchant Pass-through Parameter
    • In the third column, enter: zc_orderid
    • Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.

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

  5. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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.

    Create A New FlexForm
  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 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 osCommerce.

Your CCBill FlexForms configuration is now complete. Please skip directly to the section titled Background Post for osCommerce.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.
Save New Form
  1. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)
  2. Select Standard under Form Type, unless you intend to customize your form.
  3. Select the desired 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. Be sure to note the name of your new form, as it will be required in the osCommerce configuration section.

Form Library.jpg

Configuring the Standard Payment Form

Note: Skip this section if using FlexForms

  1. Sign in to the Admin Portal.
  2. Select the Account Info mega menu, then click Sub Account Admin, and select Basic from the left menu.
Field Name Value
Site Name Enter the URL of your osCommerce store
Approval URL http://www.youroscommercestore.com/ext/modules/payment/ccbill/ccbill_process_success.php
Denial URL http://www.youroscommercestore.com/checkout_payment.php
Redirect Time Select an Approval Redirect Time of 3 seconds, and a Denial Redirect Time of None.

Background Post for osCommerce

While still in the Sub Account Admin section, 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.

URL Type url
Approval Post URL http://www.youroscommercestore.com/ext/modules/payment/ccbill/ccbill_post_handler.php?Action=Approval_Post
Denial Post URL http://www.youroscommercestore.com/ext/modules/payment/ccbill/ccbill_post_handler.php?Action=Denial_Post

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

Configuration - osCommerce

CCBill Options

In the left menu of your osCommerce admin interface, navigate to Modules > Payment, and then select CCBill Payments. The options display on the right and clicking Edit makes the options editable.

Field Name Value
Enable CCBill Check the top box to enable payments with CCBill standard.
Client Account Number Enter your CCBill client account number.
Client SubAccount Number Enter your CCBill client sub-account number.
Form Name Enter the name of the form created during CCBill account configuration.
Is FlexForm Select Yes if using FlexForms.
Currency Select the billing currency. Ensure this selection matches the selection made in the Localization -> Currencies section of the osCommerce administration menu.
Salt Enter your salt / encryption key obtained during CCBill configuration.
Order Status Select the status that will be given to orders once payment has been completed.

Under Transaction Currency, enter the three (3)-digit currency code value for the currency you want displayed to your buyers. CCBill currently supports the following currencies:

Currency Code
US Dollar (USD) 840
Euro (EUR) 978
Australian Dollar (AUD) 036
Canadian Dollar (CAD) 124
Great Britain Pounds Sterling (GBP) 826
Japanese Yen (JPY) 392

Click Save Changes 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.

Magento


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

Overview

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

  • Installing the CCBill payment module for Magento.
  • Configuring your CCBill account for use with Magento.
  • Configuring the module with your CCBill account information.

Installation

The CCBill Magento module is available for download at the CCBill Integration Partners Marketplace. The plugin is installed by uploading the extracted (unzipped) plugin code into the location of your Magento installation. The location at which you unzip the plugin should be /app/code/CCBill/CCBillPay.

 Create a 'CCBill' Folder and 'CCBillPay' Subfolder

Before uploading the extracted plugin code, you need to create a CCBill subfolder at /app/code/, and a CCBillPay subfolder at /app/code/CCBill of your Magento installation. Once created, upload the code to /app/code/CCBill/CCBillPay.

After you have successfully copied CCBill plugin content, execute the following command from the BIN folder in Magento:

php magento setup:upgrade

Verifying Installation

You can verify your installation by checking in the top menu of your Magento admin interface by selecting System > Configuration. Select Payment Methods from the left menu. CCBill should be listed near the top of the Payment Methods page.

If it does not appear, flush the Magento cache using the System > Cache Management section of the Magento admin interface, then return to the System > Configuration > Payment Methods section. 

Configure 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 > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Enabling Dynamic Pricing

Creating a Salt / Encryption Key

A "salt" is a string of random data used to make your encryption more secure. CCBill Merchant Support will generate your Salt/Encryption Key. Once set, it will be visible at Sub Account Admin > Advanced. It will appear in the Encryption Key field of the Upgrade Security Setup Information section.

Creating A Salt

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 megamenu, click Sub Account Admin, then User Management on the left menu.
  3. Select Turn off User Management in the top section.
  4. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Disabling User Management

Webhook Setup

For the plugin to work, you will need to set up CCBill Webhooks. To do so:

  1. Log in to the CCBill Admin.
  2. Open the Account Info mega menu and navigate to Sub Account Admin.
  3. Select Webhooks from the navigation pane on the left.
  4. Under Webhook URL, enter the base URL for your Magento store, followed by:

    rest/default/V1/ccbillwebhook

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

    http://www.test.com/rest/default/V1/ccbillwebhook
  5. NewSaleSuccess and NewSaleFailure are REQUIRED Webhook notifications for the CCBill Magento plugin.
  6. Select Satelite Locations and click Update to commit the changes you have made.

Create a New Payment Form

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

 Important

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

Option 1: Creating a New FlexForms Payment Form

Note: Skip this section if using standard forms.

To set up FlexForms for use with Magento:

  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.
Saved URLs
  1. 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 Magento store, followed by:

    /index.php/ccbillpayment/router/index/?Action=Denial_Post
    For example, if your Magento store is located at http://www.test.com, the Approval URL would be:

    http://www.test.com/index.php/ccbillpayment/router/index/?Action=Denial_Post

  2. Click Save to commit your changes. Your new URL displays under Existing List.
  3. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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 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 Magento.
Continue to the Background Post for Magento section of this document.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.
Save New Form
  1. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)
  2. Select Standard under Form Type, unless you intend to customize your form.
  3. Select the desired 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. Be sure to note the name of your new form, as it will be required in the Magento configuration section.

Form Library.jpg

Configuring the New Standard Billing Form

Note: Skip this section if using FlexForms.

  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 Name Value
Site Name Enter the URL of your Magento store
Approval URL www.yourmagentostore.com/ccbillpayment/router/index/?Action=CheckoutSuccess
Denial URL http://www.yourmagentostore.com/ccbillpayment/router/index/?Action=CheckoutFailure
Redirect Time Select an approval redirect time of 3 seconds, and a denial redirect time of Instant.

Background Post for Magento

While still in the Sub Account Admin section, 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.

URL Type url
Approval Post URL http://www.yourmagentostore.com/ccbillpayment/router/index/?Action=Approval_Post
Denial Post URL http://www.yourmagentostore.com/ccbillpayment/router/index/?Action=Denial_Post

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

Configuration - Magento

General Options

In the top menu of your Magento admin interface, select System and then Configuration. Select Payment Methods from the left menu. CCBill should be listed near the top of the Payment Methods page.

Magento Admin Portal

CCBill Options

In your Magento admin interface under CCBill enter the following information:

Field Name Value
Enable CCBill Ensure Yes is selected under Enabled.
Merchant Account Number Enter your CCBill merchant account number.
Merchant SubAccount Number Enter your CCBill merchant sub-account number.
Form Name Enter the name of the form created during CCBill account configuration.
Currency Select the billing currency. Ensure this aligns with the selection made in the Currency Setup section of the Magento configuration menu.
Salt Enter your salt / encryption key obtained during CCBill configuration.

Under Currency Code, select the default currency you want displayed to your buyers. CCBill currently supports the following currencies:

Currency Code
US Dollar (USD) 840
Euro (EUR) 978
Australian Dollar (AUD) 036
Canadian Dollar (CAD) 124
Great Britain Pounds Sterling (GBP) 826
Japanese Yen (JPY) 392

Click Save Changes 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.

Opencart


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

Installation

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

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

Installing via File Upload

The CCBill OpenCart module is installed by uploading the plugin code downloaded from the CCBill website into the corresponding folders in your OpenCart installation. There are eight files which must be copied:

  • /admin/controller/extension/payment/ccbill.php
  • /admin/language/en-gb/extension/payment/ccbill.php
  • /admin/view/template/extension/payment/ccbill.twig
  • /admin/view/image/payment/ccbill.png
  • /catalog/controller/extension/payment/ccbill.php
  • /catalog/language/en-gb/extension/payment/ccbill.php
  • /catalog/model/extension/payment/ccbill.php
  • /catalog/view/theme/default/template/extension/payment/ccbill.twig

 Important!

Before installation, if you have a previous version of the CCBill payment gateway, remove it from the OpenCart admin, then upload the new code.

Installing the Module

In the left menu of your OpenCart admin interface, select Extensions > Extensions. The Extensions page appears.

OpenCart Installation
At the top of the page, select Payments from the extension type list. If the files were uploaded correctly, an option for CCBill will appear in the list.

Click the green plus button next to CCBill in the payment extensions list to install the CCBill module.

OpenCart Green Button
Once installation is complete and the page reloads, click the Edit button for CCBill to configure the CCBill module. The CCBill Settings page displays.

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

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 > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Enabling Dynamic Pricing

Creating a Salt / Encryption Key

A “salt” is a string of random data used to make your encryption more secure. CCBill Merchant Support will generate your Salt/Encryption Key. Once set, it will be visible at Sub Account Admin > Advanced. It will appear in the Encryption Key field of the Upgrade Security Setup Information section.

Creating A Salt

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 > User Management.
  3. Select Turn off User Management in the top section.
  4. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Disabling User Management

Create a New Payment Form

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

 Important

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

Note: Skip this section if using standard forms.

To set up FlexForms for use with OpenCart:

  1. Ensure All is selected in the top Client Account drop-down 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 OpenCart store, followed by:

    /index.php?route=checkout/success
    For example, if your OpenCart store is located at http://www.test.com, the Approval URL would be:

    http://www.test.com/index.php?route=checkout/success

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

    Saved URLs
  4. Add Name/Value Pairs.
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • Under Your Parameter (key), enter: zc_orderid
    • Under Use this method, select: Merchant Pass-through Parameter
    • In the third column, enter: zc_orderid
    • Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.

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

  5. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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 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 OpenCart.
Continue to the Background Post for OpenCart section of this document.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.

    Save 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.
  5. Select the desired 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. Be sure to note the name of your new form, as it will be required in the OpenCart configuration section.

Form Library.jpg

Configuring Your CCBill Account

Note: Skip this section if using FlexForms.

  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 Name Value
Site Name Enter the URL of your OpenCart store
Approval URL http://www.youropencartstore.com/index.php?route=checkout/success
Denial URL http://www.youropencartstore.com/index.php?route=checkout/failure
Redirect Time Select an approval redirect time of 3 seconds, and a denial redirect time of None.

Background Post for OpenCart

While still in the Sub Account Admin section, 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.

URL Type url
Approval Post URL http://www.opencartstore.com/index.php?route=payment/ccbill/callback_approval
Denial Post URL http://www.opencartstore.com/index.php?route=payment/ccbill/callback_denial

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

Configuration - OpenCart

CCBill Options

In the left menu of your OpenCart admin interface, hover over the Puzzle Piece menu item and select Payment. Then, select CCBill. The options display in the edit menu.

OpenCart Admin
In your OpenCart admin interface under CCBill enter the following information:

Field Name Value
Client Account Number Enter your CCBill Client account number.
Client SubAccount Number Enter your CCBill Client sub-account number.
Form Name Enter the name of the form created during CCBill account configuration.
FlexForm Select Yes if using FlexForms.
Currency Select the billing currency. Ensure this selection matches the selection made in the Localization -> Currencies section of the OpenCart administration menu.
Salt Enter your salt / encryption key obtained during CCBill configuration.
Status Select Enabled to enable CCBill as a payment option at checkout.

Click the blue Save button in the upper-right to save your settings.

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.

PrestaShop


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

Installation

The CCBill PrestaShop billing module enables easy integration of your CCBill account within the PrestaShop ecommerce platform. Installation involves the following steps:

  • Installing the CCBill payment module for PrestaShop.
  • Configuring your CCBill account for use with PrestaShop.
  • Configuring the module with your CCBill account information.
The CCBill PrestaShop module is installed by uploading the "ccbill.zip" archive via the module upload interface in your PrestaShop installation.

 Important

Before installation, if you have a previous version of the CCBill payment gateway, remove it from the PrestaShop admin, then upload the new code.

  1. In the left menu of your PrestaShop admin interface, hover over Modules and select Modules and Services.
  2. Select Upload a Module from the top menu and select ccbill.zip.
PrestaShop Installation
  1. When the upload is complete, a confirmation message will display, along with a link to configure the module options.
PrestaShop Configure

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

Dynamic Pricing

Dynamic Pricing must be enabled. You can verify that Dynamic Pricing is active at Account Info > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Enabling Dynamic Pricing

Creating a Salt / Encryption Key

A "salt" is a string of random data used to make your encryption more secure. CCBill Merchant Support will generate your Salt/Encryption Key. Once set, it will be visible at Sub Account Admin > Advanced. It will appear in the Encryption Key field of the Upgrade Security Setup Information section.

Creating A Salt

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 megamenu, click Sub Account Admin, then User Management on the left menu.
  3. Select Turn off User Management in the top section.
  4. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Disabling User Management

Create 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 PrestaShop store where a confirmation message is displayed.

 Important

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

Option 1: Creating a New FlexForms Payment Form

Note: Skip this section if using standard forms.

To set up FlexForms for use with PrestaShop:
  1. Ensure All is selected in the top Client Account drop-down 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 PrestaShop store, followed by:

    /module/ccbill/validation?Action=Approval_Post
    For example, if your PrestaShop store is located at http://www.test.com, the Approval URL would be:

    http://www.test.com/module/ccbill/validation?Action=Approval_Post

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

    Saved URLs
  4. Add Name/Value Pairs.
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • Under Your Parameter (key), enter: zc_orderid
    • Under Use this method, select: Merchant Pass-through Parameter
    • In the third column, enter: zc_orderid
    • Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.

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

  5. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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 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 PrestaShop.
Continue to the Background Post for PrestaShop section of this document.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.
Save New Form
  1. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)
  2. Select Standard under Form Type, unless you intend to customize your form.
  3. Select the desired 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. Be sure to note the name of your new form, as it will be required in the PrestaShop configuration section.

Form Library.jpg

Configuring Your CCBill Account

  1. Sign into the Admin Portal.
  2. Select the Account Info mega menu, then click Sub Account Admin, and select Basic from the left menu.
Field Name Value
Site Name Enter the URL of your PrestaShop store
Approval URL http://www.yourprestashopstore.com/order-confirmation
Denial URL http://www.yourprestashopstore.com/order-history
Redirect Time Select an approval redirect time of 3 seconds, and a denial redirect time of None.

Background Post for PrestaShop

Under the Account Info megamenu click Sub Account Admin, then select Advanced from the left menu.

URL Type url
Approval Post URL http://www.yourprestashopstore.com/module/ccbill/validation?Action=Approval_Post
Denial Post URL http://www.yourprestashopstore.com/module/ccbill/validation?Action=Denial_Post

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

Configuration - PrestaShop

General Options

  1. In the left menu of your PrestaShop admin interface, hover over Modules and select Payment.
  2. Scroll down to the bottom of the Recommended Payment Gateways list and click View all available payments solutions.
  3. On the following page, scroll down to view the modules list. Select CCBill and click Configure. The module options display.
PrestaShop Configure

CCBill Options

Field Name Value
Client Account Number Enter your CCBill merchant account number.
Client Subaccount Number Enter your CCBill merchant subaccount number.
Salt Enter your salt / encryption key obtained during CCBill configuration.
Form Name Enter the name of the form created during CCBill account configuration, or FlexForm ID if using FlexForms.
Is FlexForm Select Yes if using FlexForms.
Currency Code Select the billing currency. Ensure this selection matches the selection made in the Localization > Currencies section of the PrestaShop administration menu.

Click Save Settings 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.

X Cart


This section provides installation and configuration instructions for the CCBill X-Cart billing module.This document assumes that the reader has a working knowledge of X-Cart and has already installed the X-Cart software.

Overview

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

  • Installing the CCBill payment module for X-Cart.
  • Configuring your CCBill account for use with X-Cart.
  • Configuring the module with your CCBill account information.

Installation

The CCBill X-Cart module is installed by uploading the files in the zip file downloaded from the CCBill website into your X-Cart installation. There are two folders which must be copied:

  • /classes/XLite/Module/CCBill/CCBill_Payment
  • /skins/admin/modules/CCBill/CCBill_Payment

 Important

Before installation, if you have a previous version of the CCBill payment gateway, remove it from the X-Cart admin, then upload the new code.

Installing the Module

  1. After uploading the required files, sign into your X-Cart admin.
  2. On the left menu, navigate to System Settings > Cache Management.
  3. Click the Re-deploy the store button.
  4. Once complete, select Modules in the left menu. .
  5. Type CCBill in the search field and press Enter. If the files were copied correctly, the CCBill module will appear in your search results.
  6. Check the power symbol to enable the module.
  7. Click the Save Changes button at the bottom of the page. The store will automatically re-deploy.

X Cart Installing

Configure your CCBill Account

Before using the plugin, it’s necessary to configure a few things in your CCBill account. Please ensure the CCBill settings are correct, or the payment module will not work.

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 > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Enabling Dynamic Pricing

Creating a Salt / Encryption Key

A salt is a string of random data used to make your encryption more secure. CCBill Merchant Support will generate your Salt/Encryption Key. Once set, it will be visible at Sub Account Admin > Advanced. It will appear in the Encryption Key field of the Upgrade Security Setup Information section.

Creating A Salt

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, then User Management on the left menu.
  3. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Disabling User Management

Creating a New Payment Form

Payment forms are displayed to customers after they choose to check out. The payment form accepts customer payment information, processes the payment, and returns the customer to your X-Cart store where a confirmation message is displayed.

 Important

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

Note: Skip this section if using standard forms.

To set up FlexForms for use with X-Cart:
  1. Ensure All is selected in the top Client Account drop-down 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 X-Cart store, followed by:

    /cart.php?target=payment_return&txn_id_name=cart_order_id&action=Approval_Post
    For example, if your X-Cart store is located at http://www.test.com, the Approval URL would be:

    http://www.test.com/cart.php?target=payment_return&txn_id_name=cart_order_id&action=Approval_Post

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

    Saved URLs
  4. Add Name/Value Pairs.
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • Under Your Parameter (key), enter: merchant_order_id
    • Under Use this method, select: Merchant Pass-through Parameter
    • In the third column, enter: merchant_order_id
    • Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.

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

  5. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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 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 X-Cart.
Continue to the Background Post for X-Cart section of this document.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.
Save New Form
  1. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)
  2. Select Standard under Form Type, unless you intend to customize your form.
  3. Select the desired 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. Be sure to note the name of your new form, as it will be required in the X-Cart configuration section.

Form Library.jpg

Configuring Your CCBill Account

Note: Skip this section if using FlexForms.

  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 Name Value
Site Name Enter the URL of your X-Cart store
Approval URL http://www.yourx-cartstore.com/cart.php?target=order&order_number=%%merchant_order_id%%&Action=CheckoutSuccess
Denial URL http://www.yourx-cartstore.com/cart.php?target=order&order_number=%%merchant_order_id%%&Action=CheckoutFailure
Redirect Time Select an approval redirect time of 3 seconds, and a denial redirect time of None.

Background Post for X-Cart

While still in the Sub Account Admin section, 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.

URL Type url
Approval Post URL http://www.yourx-cartstore.com/cart.php?target=payment_return&txn_id_name=cart_order_id&action=Approval_Post
Denial Post URL http://www.yourx-cartstore.com/cart.php?target=payment_return&txn_id_name=cart_order_id&action=Denial_Post

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

Configuring X-Cart

General Options

  1. Select Store Setup in the left menu and select Payment Methods.
  2. Click the button at the top to add a payment method.
  3. Locate CCBill Payments in the list and click Add.

    X Cart Configuration
  4. The configuration page displays.

CCBill Options

Field Name Value
Client Account Number Enter your CCBill merchant account number.
Client Subaccount Number Enter your CCBill merchant sub-account number.
CCBill Form Name Enter the name of the form created during CCBill account configuration.
Is FlexForm Select Yes if using FlexForms.
Currency Select the billing currency. Ensure this selection matches the selection made in the Store Setup -> Localization -> Currencies section of the X-Cart administration menu.
Salt Enter your salt / encryption key obtained during CCBill configuration.

X Cart Payment Settings
Click Save changes at the bottom of the CCBill configuration section. You will be redirected to the payment methods list, and CCBill Payments should be marked as active. If not, click the active/inactive switch to mark it as active.

X Cart CCBill Payment
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.

VirtueMart


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. From the Joomla Admin interface, select Extensions > Extension Manager from the top menu, then select Upload Package File from the top tabs.
  2. Select the CCBill VirtueMart zip file and click Upload & Install.
VirtueMart Extension Manager
When installation is complete, VMPayment - CCBill will display in the extensions list.

Configure your CCBill Account

Before using the plugin, it’s necessary to configure a few things in your CCBill account. Please ensure the CCBill settings are correct, or the payment module will not work.

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 > Feature Summary in the Admin Portal. Your Dynamic Pricing status appears at the bottom of the Billing Tools section.

Enabling Dynamic Pricing

Creating a Salt / Encryption Key

A “salt” is a string of random data used to make your encryption more secure. CCBill Merchant Support will generate your Salt/Encryption Key. Once set, it will be visible at Sub Account Admin > Advanced.

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

Creating A Salt

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 > User Management.
  3. Select Do Not Collect Usernames and Passwords in the Username Settings section.

Disabling User Management

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 billing form accepts customer payment information, processes the payment, and returns the customer to your VirtueMart store where a confirmation message is displayed.

 Important

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

Note: Skip this section if using standard forms.

To set up FlexForms for use with VirtueMart:
  1. Ensure All is selected in the top Client Account drop-down 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.

    Saved URLs
  4. Add Name/Value Pairs

    order_pass
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • 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.

    Name.Value Parameters.jpg

    order_number
    • Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
    • 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 Parameters
    Close the Name/Value Parameters editor to return to the Saved URLs Editor.

  5. Promote to Live.
    • Click Promote under the Actions column. Your URL is now live.
    • 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 Select a Saved URL and select the URL you 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 VirtueMart.
Continue to the Background Post for VirtueMart section of this document.

Option 2: Creating a New Standard Payment Form

Note: Skip this section if using FlexForms.

  1. Sign into the Admin Portal, and navigate to the Form Admin.
  2. Click Create New Form in the left menu to create your new form.
Save New Form
  1. Select the appropriate option under Billing Type. (In most cases, this will be Credit Card.)
  2. Select Standard under Form Type, unless you intend to customize your form.
  3. Select the desired 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. Be sure to note the name of your new form, as it will be required in the Virtuemart configuration section.

Form Library.jpg

Configuring Your CCBill Account

Note: Skip this section if using FlexForms.

  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 Name Value
Site Name Enter the URL of your VirtueMart store
Approval URL http://www.yourvirtuemartstore.com/index.php?layout=details&view=orders&option=com_virtuemart&charset=utf-8&order_number=%%order_number%%&order_pass=%%order_pass%%
Denial URL http://www.yourvirtuemartstore.com/index.php?option=com_virtuemart&view=cart
Redirect Time Select an approval redirect time of 3 seconds, and a denial redirect time of None.

Background Post

While still in the Sub Account Admin section, 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.

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

Configuring 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 Name Value
Payment Name CCBill
Sef Alias ccbill
Published Yes
Payment Description Pay with your credit card with CCBill
Payment Method VMPayment - CCBill
Shopper Group Available for all
List Order 1

CCBill Options

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

Field Name Value
Client Account Number Enter your CCBill client account number.
Client Subaccount Number Enter your CCBill merchant sub-account number.
Form Name Enter the name of the form created during CCBill account configuration.
Is FlexForm Select Yes if using Flex Forms.
Currency Select the billing currency. Ensure this selection matches the selected store currency.
Salt Enter your salt / encryption key obtained during CCBill configuration.
Min Amount and Max Amount Leave these fields blank.
Cost Per Transaction and Cost Percent Total Enter zero (0) for both of these fields.

VirtueMart CCBill Options
Click the Save button.

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.