CCBill DatingPro Module

 

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.

Overview

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

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

Installation

The CCBill DatingPro module is installed by uploading the following files into the corresponding folders in your DatingPro installation.

  • application/modules/payments/models/systems/CcbillModel.php
  • uploads/payments-logo/logo_ccbill.png

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

Installing the Module

1. Access the DatingPro admin and select Payments.

2. Click Billing Systems.

Adding new billing systems to DatingPro.

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.

Install theCCBill module using the DatingPro Admin.

5. Once the module has been installed, the configuration menu displays.

Configure CCBill module in DatingPro Admin.

Configuring your CCBill Account

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.

Enable Dynamic Pricing

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

Check if Dynamic Pricing is enabled in the CCBill Admin.

Creating a Salt / Encryption Key

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

Location of Salt Key in the CCBill Admin.

Disabling User Management

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

1. Sign in to the Admin Portal.

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

3. Open the User Management menu.

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

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

Turning off the User Management feature in the CCBill Admin.

Creating a New Payment Form

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

Creating a FlexForm

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.

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 DatingPro store, followed by:
/users/account/payments_history

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

http://www.test.com/users/account/payments_history

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

A list of existing FlexForm URLs.

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.

Create a New FlexForm

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

2. The New Form dialog is displayed:

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

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

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

Background Post

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

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

Approval Post URLhttp:/YourDatingProWebsite.com/payments/responce/ccbill?Action=Approval_Post
Denial Post URLhttp:/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.

Configuration - DatingPro

General Options

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.

CCBill Options

OPTIONDESCRIPTION
Client Account NumberEnter your CCBill client account number.
Client SubAccount NumberEnter your CCBill client sub-account number.
Form NameEnter the FlexForm ID of the form created during the CCBill account configuration.
Is Flex FormCheck this box.
CurrencySelect the billing currency. Ensure this selection matches the selection made in the General section of the DatingPro administration menu.
SaltEnter 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 OPTIONSCURRENCY 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.

Activation

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.