Protected: CCBill RESTful API Schemas

This content is password protected. To view it please enter your password below:

Protected: Technical Guide for Creating and Charging Payment Tokens

This content is password protected. To view it please enter your password below:

News Archives

From the News area, click the News Archives link to view past news posts.

To List News:

  1. Select a date range using the Date Lookup pane.
  2. Select one or more Areas (such as All, Home, Reports, Tools, or Affiliates)
  3. Select one or more Types:
    • All. Review all system news.
    • Alert. Review news items that are advisory in nature.
    • System. Review news items pertaining to the Admin System.
    • Webmaster. Review news items written for merchants.
  4. Click List News to display the News report and review the selected news information.

Upload Banner (JPOST)

Use the Upload Banner function to transfer graphic files for the selected Sign Up Form. After uploading a banner it will take up to 24 business hours (excluding weekends and holidays) for it to become active while we review the banner.

After you have finished uploading the graphic files for the subaccount banners, CCBill will review the content of the files. CCBill does not allow its merchants to use non-compliant banners on Sign Up Forms.

Please enter the location of the banner that you wish to upload. The banner must be a GIF or JPG formatted file. The number of banners, banner size and orientation, and banner location may change depending on which form you use.

To upload the banners for the subaccount form:

  1. Select the Update Images on Multiple Subaccounts box if you wish these banners to be available across all subaccounts.
  2. Type the path of the graphic file in the Banner text box, or click the Browse button to search for the graphic file on your local computer. The maximum size of the graphic file in pixels is displayed next to the Banner text box.
  3. If there is more than one banner allowed for the form, then repeat step 1, until you have finished choosing the graphic files for your form.
  4. Click the Upload Banners button to transfer the graphic files to CCBill 's system.

Promotional Sales

Upsales and Cross Sales

This area allows you to add or remove Promotional Sales, which are secondary offers that may be presented to consumers as a reduced sale. For example, when you set up a subscription, you can present discounted sales to another website or to another Affiliate website by using an upsale or cross sale .

The Promotional Sales Section contains the following topics:

Display - View the Promotional sales you have set up for the subaccount.
Add/ Update - Add or remove a promotional sale.
Create Upsale - Setup a subaccount/website and the subscription pricing options for an upsale link.

There are two types of Promotional sales:

Both you and your cross sale partner must be pre-approved by CCBill in order to have a cross sale relationship. Email the sales department, sales@ccbill.com, for information about setting up partnerships with other CCBill cross sale Affiliate accounts. If you turn off the cross sale, then both partners must be approved again in order to reactivate the cross sale.

You can display two Promotional sales to customers on the Signup Form, i.e., two upsales, two cross sales, or one cross sale and one upsale. Refer to topic Form Admin > Update Form > Form Skin for more information about setting up Promotional Sales on the Signup Form. You can display one promotional sale on the Approval page, i.e., one cross sale or one upsale.

Add or Update Promotional Sales

The Create Promotional Sale page permits the addition or removal of a promotional sale.

  1. Select a Promotion Type from the drop down menu.
  2. Select the Promotion sale and pricing options from the drop down menu.
  3. Select the promotional sale account and pricing options to display on the current selected form shown in the upper area of the Selection Pane.The information displayed in the Promotion Select box contains the following:
    • The CCBill promotional sale account, which is comprised of the main account followed by the subaccount. For example, 900100-0000.
    • The pricing information options such as the subscription cost, trial period, billing type (single or recurring) and period.
  4. Click New Upsale to set up the information for an Upsale link. This opens the Create New Upsale page. New Upsale is only available only when "Upsale" is selected in the Promotional Type field.
  5. Type an SKU ID – The Sku Id only applies when DRM Networks is used to package files. The Sku Id is a License Rule created and available in the License Acquisitions Rules pane in the DRMNetworks Media Manager.
  6. Use the Referrer option to setup sales tracking for the CCBill Merchant Affiliate System or other proprietary merchant systems. Select from the following drop down menu selections:
    • Custom Referrer – Select this option to explicitly provide the referrer for the promotional sale.
    • Referrer from Original Site – Select this option if the referrer from the original sale should be credited for the promotional sale.
  7. Type the Referrer ID into the Text Box below the drop down menu; usually the Affiliate ID that was assigned to you by CCBill. If the referrer is not a CCBill Merchant Affiliate and you are using your own referrer system you can utilize the field for other tracking purposes.
  8. Check the This is a CCBill Affiliate Merchant checkbox if Referrer from Original Site is selected and you are using the CCBill Affiliate Merchant System.

Upsales can be created for CCBill Affiliates only, and only if CCBill Account Grouping has been enabled when the Affiliate program was established. If the referrer is not a CCBill Affiliate Merchant and the checkbox is not selected, Upsales and Cross sales can be created.

  1. Select Promo Text from the drop down menu. – The information to display on the Sign Up Form or Approval page for the promotional sale's subaccount.
  2. Select a promotional sale Prompt Location from the drop down menu selections: The location where to display the promotional sale.
    • Form – The promotion will be presented on the Sign Up Form or the first part of the sign up process.
    • Approval – The promotion will be presented on the Approval page or the last part of the sign up process.
    • Both – The promotion will be presented on the Sign Up Form and/ or Approval page. If the consumer selects the promotional sale on the Sign Up Form then it will not be presented again on the Approval page. Otherwise, the promotional sale will be presented on both the Sign Up Form and Approval page.
  3. Check Share Extras to permit passed in variables to be sent to the Approval Post URL for the promotional account. Check this box to permit passed in variables to be sent to the Approval Post URL for the promotional account.
  4. Click Create Promotional Sale to save the promotional sale information to CCBill's system.

Promotional Sales Report

The Promotional Sales lists the Promotional sales you have set up for the subaccount. The list is empty if no Promotional Sales have been added.

Field List (Promotional Sales Report)

Click the Delete checkbox next to the promotional sale's information to turn off the promotional sale. You may turn off an individual promotional sale or multiple promotional sales. After you have selected the promotional sales to be turned off, click the Remove button to update CCBill's system.

Click Add to enter the information for a new promotional sale. Click Add to enter the information for a new promotional sale.

Create Upsale

The Create New Upsale area allows you to set up a subaccount/website and the subscription pricing options for an upsale link.

Set up the following on the page:

Click the Create Upsale button to save the new upsale to CCBill's system. The link information for the subaccount/ website and pricing will be added to the upsale list. You can select the upsale link from the Promotion drop-down menu on the Add or Update Promotional Sales page.

Modify Subaccount Advanced

The Advanced page permits the establishment of Background Post Information, Cancel Information, and Email Validation for a subaccount.

Background Post Information

Background Post Information is used to set up URLs that optionally post customer data (minus credit card and checking details), including information sent to CCBill by way of specific URLs, when a transaction is completed.

To Set Background Post Information:

  1. Type the Approval Post URL. The URL to which basic form data will be sent, via an HTTP Post, for new signup attempts that are approved.
  2. Type the Denial Post URL. The URL to which basic form data will be sent, via an HTTP Post, for new signup attempts that are declined.
  3. Satellite Locations. Choose a server geographically close to you for the receipt of Background Posts (the default is Phoenix). Choosing a closer server can make posts both faster and less likely to fail. Available servers and IP Addresses are:
    • Phoenix, AZ. 64.38.241
    • Ashburn, VA. 64.38.212
    • Amsterdam, the Netherlands. 64.38.215

Before making your selection you need to properly configure the IP Addresses that you receive posts from in your own system to allow posts from our IP Addresses (listed in the help) and prevent post failure. If you are not sure how to do this or would like assistance, please contact Merchant Support.


FAILURE TO CONFIGURE IP ADDRESS SECURITY CAN RESULT IN FAILED BACKGROUND POSTS AND CAUSE CONSUMER ACCESS ISSUES AND OTHER SYSTEM PROBLEMS THAT CAN NEGATIVELY IMPACT YOUR BUSINESS.

  1. Click Update to save changes.

Cancel Information

Cancel Information establishes the location and hyperlink text for the customer Cancel URL. When a consumer cancels a subscription on CCBill's support site, the Text for Cancel URL will be given as a link to the Cancel URL. If the Cancel URL link is clicked, the Cancel URL will be displayed immediately; and if not, they will be redirected to the Cancel URL seven seconds after canceling the service.

To Set Cancel Information:

  1. Type the Cancel URL. The web location to send customer cancellation traffic after they have cancelled.
  2. Type the Text for Cancel URL. The hyperlink text to display for the customer that will describe the web location specified by the Cancel URL.
  3. Click Update to save changes.

Email Validation

Email Validation establishes email, payment, and affiliate validation options. During the signup process, consumers who meet specified criteria receive a confirmation email from CCBill. Email Validation requires that consumers confirm the information by clicking on a provided link before obtaining a subscription.

Some options may not be available to you. Please contact Merchant Support if you would like to utilize the options mentioned here but not showing in the Admin.

Follow these steps to Set Email Validation:

  1. Apply Country Validation. Select YES to utilize country validation and display the list with available countries. Select NO to exclude country validation via email.
  2. Countries. Click on the country to be validated via email when a consumer enters it on the Signup form. Hold down the Control key to select multiple countries. The countries list will not be displayed if NO is selected in the previous field.
  3. Apply Payment Validation. Select YES to utilize payment validation and display the available payment options. Select NO to exclude payment validation via email.
  4. Cards Accepted. Use the check boxes to select the payment options for validation via email during the signup process. The payment options will not be displayed if NO is selected in the previous field.
  5. Apply Affiliate Validation. Select YES to utilize affiliate validation and display the affiliate text box where Affiliate IDs can be entered. Select NO to exclude affiliate validation via email.
  6. Affiliates. Enter the Affiliate ID(s) to validate via email during the signup process. Affiliate IDs must be separated by commas, e.g., 123456, 124365, 123344 when entered into the text box. The affiliate text box will not be displayed if NO is selected in the previous field.
  7. Click Update to save changes.

Setting up Google™ Analytics

CCBill offers support for adding analytics code (provided by Google™) to your forms. Google™ Analytics allows you to track specific data about the people who use your website. For more information about Google™ Analytics, or to sign up for a Google™ Analytics account, please visit their website. To use this feature, you must first obtain a Web Tracking ID from your Google™ Analytics account. Paste the ID in the Google Analytics box, and click Update. You MUST use the Reset All Forms link to complete the process.

Setting up Google™ Analytics on the sub-account level will only affect the change on that individual sub-account. To add the same Google™ Analytics code for ALL sub-accounts, make the change on the Main Account instead of on the sub-account (on the Account Info Mega Menu Main Account>Account Admin).

Be aware that if you have analytics set up for a subaccount and then apply analytics at the main account level the subaccount setting will NOT be overwritten. You will have to add the new analytics code to that subaccount manually (on the Account Info Mega Menu Manage the Subaccounts>Subaccount Admin>Advanced).

Layout

The Layout area permits the setup of Terms and Conditions, Confirmation page, and Sign Up Form Options. The Form Options for each payment type are slightly different.

Keep in mind that certain layout options for a new subaccount are initially disabled by CCBill. Other layout options may be disabled, if you have requested them to be shut off, or if CCBill has shut them off for another reason. If you cannot access or change any of the layout options, contact Merchant Support to have them enabled.

The following layout options are available:

It is required to present consumers with both the terms and conditions of the purchase and the consumer service information on the Sign Up Form.

Enter the following in the Terms and Conditions Options area:

Confirmation Options

This area sets up the options for the Confirmation page. For new subaccounts, the Confirmation options are disabled by default. If you need to use the Confirmation options, contact Merchant Support to have them activated. Once CCBill activates an option, you can enable or disable any individual option for the subaccount's Confirmation page.
Enter the following in the Confirmation Options area:

Form Options

You will be asked to enter different Form Options for the selected of Sign Up Form type (i.e., Credit Card, Checking, or Telephone Billing). Credit Card Sign Up Forms end with "cc", Checking Sign Up Forms end with "ck", and Telephone Billing Forms end with "t9".

How do I cancel my CCBill Merchant Account?


You can cancel your account at CCBill at any time with 10 days written notice. Once your account has been terminated / cancelled, CCBill will hold all funds due to you for a minimum of six months as reserve for possible refunds, returned checks and chargebacks. The account will no longer be accessible by you or anyone else.

In order to cancel your account at CCBill you need to submit an Account Cancellation form.

 Disclaimer

Cancellations via telephone and email will not be considered as acceptable forms of notice.

CCBill Background Post System


The CCBill Background Post System permits CCBill merchants to pre-fill customer information and send variables to CCBill through the Sign Up Form . Optionally, merchants can capture CCBill’s returned variables through the Approval Post URL and/ or a Denial Post URL. The information contained within the Background Post System documentation is written for Programmers, Technicians and other individuals with advanced programming skills.


Approval and Denial Posts

The CCBill System is capable of passing back Approval Post URL, Denial Post URLs, and other variables sent to the Signup Form (credit card and bank account details are excluded) provided they are entered in the Modify Subaccount > Advanced page of the CCBill Admin Portal.

Refer to topic Variables List for a list and description of the Background Post variables. The variable names must be entered exactly as shown to receive the information properly.

Once the Approval and/or Denial or Post URLs have been entered into CCBill’s system, all the Background Post variables and the custom variables will be passed to the URLs you specified and can capture the returned variables with a script configured to receive Form Post information.

The Approval Post URL or Denial Post URL should point to a script such as CGI, PHP, ASP, etc.

For Example:

Post URL is as follows: http://www.yourwebsite.com/cgi-bin/your_script.cgi

The script should be programmed to receive and parse the information passed from CCBill according to your program language specifications. The returned values may be used for any purpose (e.g., After receiving the values, write them to a database for record keeping or pass them to another script.).

An example of a CCBill variable is customer_fname, which represents the customer’s first name. The variable will be originally sent from the CCBill Signup Form as customer_fname. If using a CGI script, the value might be parsed as $cust_first_name = param("customer_fname"). Please be aware that the variable name $cust_first_name can be any name chosen. The Pass Back variable as customer_fname must be specified to properly receive the information.

Please refer any questions you have concerning this type of code to a qualified programmer.


Passing Variables to Sign Up

CCBill’s Sign Up Forms are capable of being pre-filled, as well as additional variables may be passed into CCBill’s system. This allows you to prefill the Sign Up Form or execute Admin Portal actions. Refer to topic Variables List for a list and description of the Background Post variables.

To pre-fill the Sign Up Form or execute Admin Portal actions:

  1. Copy and add the HTML code created in the Generate HTML area of the Admin Portal to your website. You can replace the default HTML button code with the HTML link code on the Index page or other page that links to the Sign Up Form at anytime.
  2. Add the prefill variable or action variable using a post hidden field method or get method to the HTML code that loads the Sign Up Form. Refer to the examples below for more information about how to pre-fill the Sign Up Form and how to execute Admin Portal actions.

Custom variables may be passed in; for example, VariableName and VariableName2. To pass in custom variables, add them in between the form tags of the HTML code to load the Sign Up Form.

Example: (Passing Custom Variables to Sign Up Form)

<form action='https://bill.ccbill.com/jpost/signup.cgi'  method=POST>  <input  type=hidden name=clientAccnum  value='900000'>  <input  type=hidden name=clientSubacc  value='0000'>  <input type=hidden  name=formName  value='7cc'>  <input type=hidden name=VariableName value=VariableValue>  <input type=hidden name=VariableName2 value=VariableValue2>  <input type=submit name=submit  value='Join  Now'>  </form>

You will need to rename the custom variables in accordance to how they will be defined. The values will be sent to the Sign Up Form as extra variables.

If you encounter problems, contact merchantsupport@ccbill.com for assistance. You do not have to install CCBill's Sign Up Form on your site. You only have to add the HTML code created in the Generate HTML area to the location on your website where you want to load the Sign Up Form.

Example: (Passing Static Variables)

The examples listed below show the following HTML code: Sign Up Form and Execute Admin Portal Action. Keep in mind that the variables shown in the examples represent static variables.

<form action='https://bill.ccbill.com/jpost/signup.cgi' method=POST>  <input type=hidden name=clientAccnum value='900100'>  <input type=hidden name=clientSubacc value='0000'>  <input type=hidden name=formName value='8ck'>  <input type=hidden name=allowedTypes value='0000005835,0000000265,0000007444'>  <input type=hidden name=subscriptionTypeId value='0000007444' >  <input type=hidden name=email value='custemail@website.com'>  <input type=submit name=submit value='Join Now'>
<A HREF=https://bill.ccbill.com/jpost/signup.cgi?clientAccnum=900100&clientSubacc=0000&formName=8ck &allowedTypes=0000005835,0000000265,0000007444&subscriptionTypeId=0000007444 &email=youremail@website.com>Join Now</A>

You may add the HTML for a button or link to the Form, such as writeCache, which executes an Admin Portal action. The HTML code for a button or link to load the Sign Up Form will look like:

form action='https://bill.ccbill.com/jpost/signup.cgi' method=POST>  <input type=hidden name=clientAccnum value='900100'>  <input type=hidden name=clientSubacc value='0000'>  <input type=hidden name=formName value='8ck'>  <input type=hidden name=allowedTypes value='0000005835,0000000265,0000007444'>  <input type=hidden name=subscriptionTypeId value='0000007444' >  <input type=hidden name=writeCache value='1'>  <input type=submit name=submit value='Join Now'>
<A HREF=https://bill.ccbill.com/jpost/signup.cgi?clientAccnum=900100&clientSubacc=0000 &formName=8ck&allowedTypes=0000005835,0000000265,0000007444&subscriptionTypeId=0000007444 &writeCachc=1>Join Now</A>

Another way of passing information to the CCBill Sign Up Form is through dynamic variables. You can use dynamic variables to prefill customer information. This will require you to create a form to suit your specific needs. The form will pass the information to another script written using CGI, PHP, ASP, etc., which contains your code to load the Sign Up Form.

The form you create will pass the customer inputted information to your button or Link code script page. This script will pass the variables to the CCBill signup Form when your customer loads it. After customer approval or denial, the information that you originally passed in will be sent to the Approval or Denial Post URL and ultimately to your script.

Example: (Passing Dynamic Variables)

print" <form action='https://bill.ccbill.com/jpost/signup.cgi' method=POST>";  print" <input type=hidden name=clientAccnum value='900100'>";  print" <input type=hidden name=clientSubacc value='0010'>";  print" <input type=hidden name=formName value='11cc'>";  print" <input type=hidden name=language value='English'>";  print" <input type=hidden name=allowedTypes value='0000000111,0000000318'>";  print" <input type=hidden name=subscriptionTypeId value='0000000318'>";  print" <input type=hidden name=customer_fname value='$cust_first_name'>";  print" <input type=submit name=submit value='Join Now'>";  print" </form>";
print"<A HREF=https://bill.ccbill.com/jpost/signup.cgi?clientAccnum=900100&clientSubacc=0010 &formName=11cc&language=English&allowedTypes=0000000111,0000000318&subscriptionTypeId=0000000318 &customer_fname=$cust_first_name> Join Now</A>";

Do not add any spaces to the link code example shown above.

Please refer any questions you have concerning this type of code to a qualified programmer.


Background Post Variables

A full list of variables, as well as Decline Codes and further information about the Background Post System is available in the Background Post User's Guide.

View All Subaccounts

This section provides a general overview of the Account Admin. In the Account Admin area, links are displayed in the Selection Pane and all subaccounts are listed in the report area.

The following links permit access to Main Account information or the addition of a new Subaccount:

Subaccount List Report

The Subaccount List report displays a list of subaccounts, their associated websites and other information that may be reviewed or modified.

To Modify Subaccount Data:

  1. Click the link for the appropriate subaccount and display the Modify Subaccount screen where the subaccount can be edited. Refer to the Modify Subaccount section for more information about the Subaccount report.
  2. If a declined subaccount is selected, an Information page will be displayed with the reason(s) the account was declined and the subaccount will be inaccessible. Contact merchantsupport@ccbill.com for more information and go to Step 6.
  3. Review the data pertaining to the individual subaccount such as URLs, options, account data, user management, forms and pricing options in the Subaccount Information area.
  4. To setup the common options for the subaccount and associated website, modify the data pertaining to it in the Subaccount Information area by using the links in each of the following frames:
    • User management
    • Forms
    • Pricing options
  5. To setup all the subaccount options, use the links in the Modify Subaccount Selection Pane to open specific functions for the subaccount.
  6. Repeat the above steps to setup other subaccounts.