Welcome to the CCBill Integration Manuals section of the Knowledge Base. Here you will find instructions on how to integrate CCBill with various third-party solutions.
The integrations are maintaned by CCBill third-party integration partners. For any issues, please reach out to the integration partner in question.
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.
The CCBill PrestaShop billing module enables easy integration of your CCBill account within the PrestaShop ecommerce platform. Installation involves the following steps:
The CCBill PrestaShop module is installed by uploading the "ccbill.zip" archive via the module upload interface in your PrestaShop installation.
Before installation, if you have a previous version of the CCBill payment gateway, remove it from the PrestaShop admin, then upload the new code.
To install the CCBill module in PrestaShop:
1. Access the PrestaShop admin interface.
2. Hover over Modules and select Modules and Services.
3. Select Upload a Module from the top menu and select ccbill.zip.
4. When the upload is complete, a confirmation message will display, along with a link to configure the module options.
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.
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.
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.
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.
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.
To create a FlexForm form 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.
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.
/module/ccbill/validation?Action=Approval_PostFor 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_Post3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
5. Under Your Parameter (key), enter: zc_orderid
6. Under Use this method, select: Merchant Pass-through Parameter
7. In the third column, enter: zc_orderid
8. Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.
9. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.
10. Click Promote under the Actions column. Your URL is now live.
11. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
To create a billing form for use with PrestaShop:
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.
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.
Be sure to note the name of your new form, as it will be required in the PrestaShop configuration section.
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 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. |
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 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.
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.
| OPTION | DESCRIPTION |
|---|---|
| Client Account Number | Enter your CCBill client account number. |
| Client SubAccount Number | Enter your CCBill client sub-account 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 Flex Form | Select Yes if using FlexForms. |
| Currency | Select the billing currency. Ensure this selection matches the selection made in the Localization > Currencies section of the PrestaShop administration menu. |
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.
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.
The CCBill OpenCart billing module enables easy integration of your CCBill account within the OpenCart e-commerce platform. Installation involves the following steps:
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 that need to be copied:
Before installation, if you have a previous version of the CCBill payment gateway, remove it from the OpenCart admin, then upload the new code.
To install the CCBill payment module in OpenCart:
1. Access the OpenCart admin interface.
2. Expand the Extensions menu.
3. Click Extensions.
4. At the top of the page, select Payments from the extension type list.
5. 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.
Once installation is complete and the page reloads, click the Edit button for CCBill to configure the CCBill module. The CCBill Settings page displays.
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.
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.
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.
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.
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.
To create a FlexForm form 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.
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.
/index.php?route=checkout/successFor example, if your OpenCart store is located at http://test.com, the Approval URL would be:
http://www.test.com/index.php?route=checkout/success3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
5. Under Your Parameter (key), enter: zc_orderid
6. Under Use this method, select: Merchant Pass-through Parameter
7. In the third column, enter: zc_orderid
8. Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.
9. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.
10. Click Promote under the Actions column. Your URL is now live.
11. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
To create a billing form for use with OpenCart:
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.
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.
Be sure to note the name of your new form, as it will be required in the OpenCart configuration section.
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. |
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 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.
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.
In your OpenCart admin interface under CCBill enter the following information:
| OPTION | DESCRIPTION |
|---|---|
| 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, or FlexForm ID if using FlexForms. |
| Is Flex Form | 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.
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.
The CCBill Magento billing module enables easy integration of your CCBill account within the Magento e-commerce platform. Installation involves the following steps:
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.
1. The location at which you unzip the plugin should be /app/code/CCBill/CCBillPay. Before uploading the extracted plugin code, you need to create a CCBill directory at /app/code/, and a CCBillPay sub-directory at /app/code/CCBill of your Magento installation.
2. Once created, upload the code to /app/code/CCBill/CCBillPay.
3. After you have successfully copied CCBill plugin content, execute the following command from the BIN folder in Magento:
php magento setup:upgradeYou 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.
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.
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.
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.
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.
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.
Under Webhook URL, enter the base URL for your Magento store, followed by:
rest/default/V1/ccbillwebhookFor example, if your Magento store is located at http://www.test.com, the Approval URL would be:
http://www.test.com/rest/default/V1/ccbillwebhook4. NewSaleSuccess and NewSaleFailure are REQUIRED Webhook notifications for the CCBill Magento plugin.
5. Select Satellite Locations and click Update to commit the changes you have made.
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.
To create a FlexForm for use with Magento:
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.
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.
/index.php/ccbillpayment/router/index/?Action=Denial_PostFor 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_Post3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
5. Under Your Parameter (key), enter: zc_orderid
6. Under Use this method, select: Merchant Pass-through Parameter
7. In the third column, enter: zc_orderid
8. Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.
9. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.
10. Click Promote under the Actions column. Your URL is now live.
11. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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 Magento section of this document.
To create a billing form for use with Magento:
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.
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.
Be sure to note the name of your new form, as it will be required in the Magento configuration section.
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 | http://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. |
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..
| 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 displayed information is correct.
To configure the CCBill payment module in Magento:
1, Access the Magento Admin.
2. Expand the Stores menu.
3. Select the Configuration option.
4. Expand the Sales drop-down.
5. Click Payment Methods.
6. Locate the CCBill payment module and click Configure.
In your Magento admin interface under CCBill enter the following information:
| OPTION | DESCRIPTION |
|---|---|
| Enable CCBill | Ensure Yes is selected under Enabled. |
| 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, or FlexForm ID if using FlexForms. |
| 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 to be 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 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.
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.
The CCBill X-Cart billing module enables easy integration of your CCBill account within the X-Cart e-commerce platform.
The installation involves the following steps:
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 that need to be copied:
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.
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.
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.
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.
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.
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.
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 forOption 1 or Option 2, according to your selection.
To create a FlexForm form 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.
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.
/cart.php?target=payment_return&txn_id_name=cart_order_id&action=Approval_PostFor 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_Post3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
5. Under Your Parameter (key), enter: merchant_order_id
6. Under Use this method, select: Merchant Pass-through Parameter
7. In the third column, enter: merchant_order_id
8. Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.
9. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.
10. Click Promote under the Actions column. Your URL is now live.
11. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
To create a standard billing form for use with X-Cart:
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.
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.
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. |
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 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.
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.
4. Enter your CCBill account information. See individual field details below.
| OPTION | DESCRIPTION |
|---|---|
| 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, or FlexForm ID if using FlexForms. |
| Is Flex Form | 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. |
5. Click Save changes at the bottom of the CCBill configuration section.
6. The system redirects you 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.
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.
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.
The CCBill VirtueMart billing module enables easy integration of your CCBill account within the VirtueMart e-commerce platform. Installation involves the following steps:
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.
When installation is complete, VMPayment - CCBill will display in the extensions list.
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.
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.
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.
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.
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.
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.
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.
/index.phpFor example, if your VirtueMart store is located at http://www.test.com, the Approval URL would be:
http://www.test.com/index.php3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
order_pass
order_number
layout
option
view
Your saved parameters display under Currently Defined Name/Value Pairs.
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.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
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.
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.
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. |
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 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 |
Your CCBill account is now configured. In your CCBill Admin interface, navigate to Sub Account Admin and ensure the displayed information is correct.
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 |
Next, click the Configuration tab and enter your CCBill account information.
| OPTION | DESCRIPTION |
|---|---|
| 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, or FlexForm ID if using FlexForms. |
| Is Flex Form | Select “Yes” if using FlexForms. |
| 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. |
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.
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.
The installation involves the following steps:
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 that need to be copied:
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.
2. Click Install Module.
3. Select CCBill Payments from the list and click Install Module.
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.
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.
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.
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.
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.
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.
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.
To create a FlexForm form 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.
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.
/ext/modules/payment/ccbill/ccbill_post_handler.php?Action=Approval_PostFor 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_Post3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
5. Under Your Parameter (key), enter: zc_orderid
6. Under Use this method, select: Merchant Pass-through Parameter
7. In the third column, enter: zc_orderid
8. Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.
9. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.
10. Click Promote under the Actions column. Your URL is now live.
11. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
Your CCBill FlexForms configuration is now complete. Please skip directly to the section titled Background Post for osCommerce.
To create a billing form for use with osCommerce:
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.
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.
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 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. |
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.
| 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.
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.
Enter your CCBill account information. See individual field details below.
| 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, or FlexForm ID if using FlexForms. |
| Is Flex Form | 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 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.
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.
The CCBill WooCommerce billing module enables easy integration of your CCBill account within the WooCommerce ecommerce platform for WordPress. Installation involves the following steps:
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.
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.
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.
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.
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.
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.
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.
For the plugin to work, you will need to set up CCBill Webhooks. To do so:
1. Log in to the CCBill Admin.
2. Select the subaccount to be used with WooCommerce from the top Client Account dropdown.
3. Open the Account Info mega menu and navigate to Sub Account Admin.
4. Select Webhooks from the navigation pane.
5. Under Webhook URL, enter the base URL for your WooCommerce store, followed by:
/?wc-api=WC_Gateway_CCBillFor 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_CCBillNewSaleSuccess and NewSaleFailure are REQUIRED Webhook notifications for the CCBill WooCommerce plugin.
6. Select Satellite Locations and click Update to commit the changes you have made.
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.
To create a FlexForm form 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.
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.
/?wc-api=WC_Gateway_CCBill&Action=CheckoutSuccessFor 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=CheckoutSuccess3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click the plus (+) symbol under Name/Value Pairs in the SANDBOX column.
5. Under Your Parameter (key), enter: wc_orderid
6. Under Use this method, select: Merchant Pass-through Parameter
7. In the third column, enter: wc_orderid
8. Under Action, click the Add button to save this parameter. Your saved parameters display under Currently Defined Name/Value Pairs.
9. Close the Name/Value Parameters editor to return to the Saved URLs Editor. Your new URL displays in the Existing List.
10. Click Promote under the Actions column. Your URL is now live.
11. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
To create a billing form for use with WooCommerce:
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.
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.
Be sure to note the name of your new form, as it will be required in the WooCommerce configuration section.
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 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 None. |
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.
| 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.
In your WordPress admin interface, navigate to WooCommerce and select General from the top menu.
In your WordPress admin interface, navigate to WooCommerce and select Checkout from the top menu, then select CCBill from the top submenu.
| OPTION | DESCRIPTION |
|---|---|
| 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, or FlexForm ID if using FlexForms. |
| Is Flex Form | Select “Yes” 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. |
Under Currency Options, select the default currency you want displayed to your buyers. CCBill currently supports the following currencies:
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.
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.
The goal of this document is to provide installation and configuration instructions for the CCBill DatingPro billing module. This document assumes that the reader has a working knowledge of DatingPro and already has a functional DatingPro website.
The CCBill DatingPro billing module enables easy integration of your CCBill account within the DatingPro e-commerce platform. Installation involves the following steps:
The CCBill DatingPro module is installed by uploading the following files into the corresponding folders in your DatingPro installation.
Before installation, if you have a previous version of the CCBill payment gateway, remove it from the DatingPro admin, then upload the new code.
1. Access the DatingPro admin and select Payments.
2. Click Billing Systems.
3. Select Install from the top row of buttons.
4. If the installation files were uploaded correctly, CCBill will display in the list. Click the blue Install button next to CCBill to install the module.
5. Once the module has been installed, the configuration menu displays.
Before using the plugin, it is necessary to configure a few things in your CCBill account. Please ensure the CCBill settings are correct, or the payment module will NOT work.
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.
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.
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.
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 DatingPro website where a confirmation message is displayed.
To create a FlexForm form for use with DatingPro:
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.
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.
/users/account/payments_historyFor example, if your DatingPro store is located at http://test.com, the Approval URL would be:
http://www.test.com/users/account/payments_history3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Click Promote under the Actions column. Your URL is now live.
5. Close the Saved URLs editor to return to the main FlexForms menu.
1. Click the Add New button in the upper left to create a new form.
2. The New Form dialog is displayed:
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.
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 URL | http:/YourDatingProWebsite.com/payments/responce/ccbill?Action=Approval_Post |
| Denial Post URL | http:/YourDatingProWebsite.com/payments/responce/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.
In the left menu of your DatingPro admin interface, select Payments > Billing Systems. Select the arrow on the right of the blue button for CCBill and choose Edit.
| OPTION | DESCRIPTION |
|---|---|
| Client Account Number | Enter your CCBill client account number. |
| Client SubAccount Number | Enter your CCBill client sub-account number. |
| Form Name | Enter the FlexForm ID of the form created during the CCBill account configuration. |
| Is Flex Form | Check this box. |
| Currency | Select the billing currency. Ensure this selection matches the selection made in the General section of the DatingPro administration menu. |
| Salt | Enter your salt/encryption key obtained during CCBill configuration. |
Under Currency Options, select the default currency you want displayed to your buyers. CCBill currently supports the following currencies:
| CURRENCY OPTIONS | CURRENCY CODES |
|---|---|
| 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 at the bottom of the CCBill configuration section.
Back at the payment module list, click the blue Activate button next to CCBill to activate your CCBill module.
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.
WHMCS is a complete client management, billing, and support solution for online hosting businesses. Since 2005, they have been helping web hosting companies automate their operations, reduce costs, and deliver a better experience to their end-users. With a wide range of integrations, WHMCS can provide a unique centralized platform for managing your web hosting business. They handle everything from customer signup to provisioning and support.
The goal of this document is to provide installation and configuration instructions for the CCBill WHMCS billing module. This document assumes that the reader has a working knowledge of WHMCS and has already signed up for WHMCS.
The CCBill WHMCS billing module is used for WHMCS for both one-time and recurring billing. This module is compatible with WHMCS 6.2.0.
The CCBill WHMCS billing module enables easy integration of your CCBill account within the WHMCS platform. Installation involves the following steps:
The CCBill WHMCS module is installed by uploading the extracted (unzipped) plugin code downloaded from the CCBill website into the appropriate folders of your WHMCS installation, as outlined below:
*ccbillerror.tpl
Please note that ccbillerror.tpl needs to be copied to the folder of the WHMCS template in use. For example, if you are using template Six, copy ccbillerror.tpl to folder six.
Before using the plugin, it is necessary to configure a few things in your CCBill account. The following CCBill settings must be correct for the payment module to work correctly.
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.
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.
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 Turn off User Management in the top section.
4. Select Do Not Collect Usernames and Passwords in the Username Settings section.
For the plugin to work, you will need to set up CCBill Webhooks. To do so:
1. Log into 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 WHMCS store, followed by:
modules/gateways/callback/ccbillmodule.phpFor example, if your WHMCS store is located at www.teststore.com, the Approval URL would be:
www.teststore.com/modules/gateways/callback/ccbillmodule.php5. If you entered a Webhook Key (optional) on the CCBill module configuration page, you must append that value to the Approval URL. For more details regarding the Webhook Key, please refer to CCBill Options in WHMCS.
modules/gateways/callback/ccbillmodule.php?whKey=''value''For example, if your whKey value is 12345, the Approval URL would be:
http://www.teststore.com/modules/gateways/callback/ccbillmodule.php?whKey=123456. NewSaleSuccess, RenewalSuccess, NewSaleFailure, and Cancelation are REQUIRED Webhook notifications for the CCBill WHMCS plugin.
The payment form is the CCBill form that will be displayed to your clients. The payment form accepts customer payment information, processes the payment, and sends the client to a designated URL after the payment has been processed.
Below you will find additional instructions on how to create a FlexForm payment form. If you need a more in-depth user guide, please refer to our FlexForms Overview.
To create a FlexForm for use with Ubersmith:
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.
Once a consumer has made a successful payment through CCBill, they need to be redirected back to your WHMCS online store. To do so, we need to define a redirect URL upon approval.
1. Click the URLs Library button in the upper-right corner of the screen 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.
3. Click Save to commit your changes. Your new URL displays under Existing List.
4. Promote to Live.
1. Click the Add New button in the upper left to create a new payment flow. You are now essentially editing the first tile of the Payment Flow. In this case, you will be creating a FlexForm payment form for your WHMCS clients.
2. The New Form dialog is displayed:
3. 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.
4. Promote to Live. Click the Promote to Live button to enable your new form to accept payments.
5. Take note of the FlexForms ID. You will need to provide the FlexForm ID on the CCBill Payment Gateway Module page in the WHMCS admin panel.
All of these settings and many other can be modified in the FlexForms Editor at every moment. Pop up the Editor by clicking the Forms Library button in the upper-right corner of the screen. There you can create new forms as well, by clicking the Create New Form button.
In the top menu of your WHMCS admin panel, please select Setup > Payments > Payment Gateways. Select All Payment Gateways and find and click the CCBill Payment Gateway Module option.
To configure the module, select Manage Existing Gateways.
The next section will outline how to fill in the fields on the CCBill Payment Gateway Module page.
On the CCBill Payment Gateway Module page, enter the following information.
| Show on Order Form | Make sure to check this option to enable CCBill Payment processing. |
| Client Acct # | Enter your CCBill merchant account number. |
| Client Sub Acct # | Enter your CCBill merchant sub-account number. |
| Flex ID | Enter the FlexForm ID created during the CCBill account configuration. |
| Salt | Enter your salt/encryption key obtained during CCBill configuration. |
| Webhook Key (Optional) | This is an optional parameter. However, it is advised to define a Webhook Key for added security. |
Click Save Changes at the bottom of the CCBill configuration section.
You are now ready to process payments via CCBill!
Products you create in WHMCS will now interact with the CCBill shopping cart and checkout process.
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.