Single click donations with CiviCRM

From Creative Commons
Revision as of 19:01, 11 September 2010 by Cargames (talk | contribs)
Jump to: navigation, search


Creative Commons has developed a modified donation process using CiviCRM which can potentially send a contributor off to the payment processor with as little as a single click. All of the donation buttons on CC's donation page utilize this process.

There are a number of possible benefits to using this method as opposed to regular contribution pages in CiviCRM:

  • The contributor (potentially) makes a single click to donate on your site. The less clicks/keystrokes the better chance someone will complete a contribution. I believe this has been empirically tested and demonstrated (??).
  • You are no longer limited to designing your contribution pages within the confines/scope of Drupal and CiviCRM. You can create pages the way you want, wherever you want. This is especially nice for widgets, or anyone else wanting to help your campaign. Potentially, people can create their own donate links on their own sites ... it doesn't matter. And if you run multiple sites, you can place Donate links wherever you want on any of those sites, and it makes no difference whether it's run by Drupal, Wordpress, Joomla, or even made with static HTML.
  • Tired of Pending (Incomplete Transaction) contribution statuses and bogus contacts for people who never completed a transaction? This method virtually eliminates those because a contact/contribution is not created in the CiviCRM database until an IPN/notification is received from the payment processor.
  • As long as the "one-click" scripts are in place, the state of your CiviCRM install doesn't really matter from a user perspective, at least as it relates to contributions. This has been useful for CC when upgrading -- not having to worry about disrupting live contributions should an upgrade encounter problems.

The system is currently comprised of two files: a class file which contains all the code, and a simple router/wrapper script which receives and routes incoming requests:

Special Considerations

This method is known to work with CiviCRM versions 2.2.7, 3.1.1 and 3.1.3. It should work fine with any version in the 2.2.x or 3.1.x line.

It currently works with PayPal and Google Checkout.

Configuring CiviCRM for use with OneClick

The OneClick system may require you to make a few configurations in CiviCRM, depending on your needs and how you plan to use OneClick.

  • General: these things should be done no matter what:
    • Administer -> Customize -> Custom Data: here we create a custom data field that is somewhat for internal use but is required for email receipts to work with Google Checkout, but could be useful for future reference or debugging. Create a 'New Group of Custom Fields' Used For - Contributions of Type - Donation. The Group Name doesn't matter. Now add a new Custom Field to the group with these attributes:
      • Field Label (*exactly*): 'OneClick Custom Data'
      • Data and Input Field Type: Alphanumeric - Text
      • Database field length (arbitrarily large): 2000
  • Email receipts: if you'd like to automatically send your donors a receipt by email, then you'll need to do these things:
    • Administer -> Configure -> FROM Email Addresses: add a new FROM address and the Description field must be *exactly*: 'OneClick Email Receipts'. This is the address the receipt will appear to come from. The address will also be Bcc'd on the receipt, and will also be the Reply-To address.
    • Administer -> Configure -> Message Templates: create a new template. This will be the body of the receipt email, and the Message Subject of the template will become the email Subject:. Note the database ID of the template, because you will need to pass this into the system at some point (see Usage -> receipt below).
  • Google Checkout: if you plan to utilize Google Checkout, then you need to do these things:
    • Administer -> Configure -> Global Settings -> Payment Processors: create a new payment processor of type 'Google Checkout and the Name field must be *exactly*: 'Google Checkout API Access'. Fill in the rest of the fields as necessary.
    • Login to your Google Checkout merchant account and go to Settings -> Integration and set the API callback URL to: https://<yourdomain>/sites/default/modules/civicrm/bin/OneClick.php?oc_action=googleipn
  • Optional:
    • Administer -> Customize -> Custom Data: here we create a custom data field that can be used to determine whether a user wants their name to appear in a list of recent donors on your site. NOTE: by itself this field will do nothing for you. It is simply a flag against which you can write your own code to display, or not, your donor names on your site. Use the same custom data group from General above. Now add a new Custom Field to the group with these attributes:
      • Field Label (*exactly*): 'OneClick Supporter List'
      • Data and Input Field Type: Alphanumeric - Text
      • Database field length: 256


All of the following are found and set in the file bin/OneClick.class.php. There are a few more variables, but the following are the only ones you should change unless you know what you're doing.

// Turn IPN debuggin on/off.  Logs to CiviCRM's default log file.
const OC_DEBUG = TRUE;

// Valid groups that users can join.  This is just a safeguard to prevent
// users from joining arbitrary groups
public $_valid_groups = array(
    'CC Newsletter',
    'CC Events'

// IPN callback URL for PayPal
$_paypal_notify_url = 'https://$domain/sites/default/modules/civicrm/bin/OneClick.php?oc_action=paypalipn';

// Email address of site's PayPal account
$_paypal_business = '';

// Minimum contribution amount, anything lower will be kicked back.
$_min_amount = '5';
// An array of URLs that should be notified when an incoming
// contribution (via IPN) is successfully processed.
$_notify_urls = array(

// Default name of item as contributor sees it and as recorded in CiviCRM.
$_item_name = 'Online Contribution: Support Creative Commons';

// Where contributor goes if they cancel contribution at payment processor
$_cancel_return = '';

// Where user goes when they click "Return to Merchant Site"
$_return = '';


Anyone can make use of OneClick.php from anywhere, but the script expects certain variables to be passed to it. The only variables which are absolutely necessary are oc_action, pp' and amount. Here is a summary of the possible variables, which can be sent by either a GET or POST request:

  • oc_action (required): The value of this should always be 'donate'. The only other valid values are ones sent by the payment processor. Example: ?oc_action=donate
  • pp (required): The payment processor to use. Presently it can be one of paypal and gc (for Google Checkout). Example: ?pp=paypal
  • amount (required): The amount of the contribution, with no currency symbol. It can be a floating number, but will get rounded to two decimal places if for some reason it has more. Example: ?amount=150
  • cancel_return (optional): This is the URL the contributor will be directed to should they for some reason click a Cancel link on the payment processor's site without having completed the transaction. Will always have a predefined default value should it not be passed. Example (urlencoded): ?
  • groups (optional): A colon separated list of groups that the user should be subscribed to. The group names are the exact names as they are found in the CiviCRM database, spaces and all. OneClick will not let users join arbitrary groups. Passed groups that are not in the predefined groups list in $_valid_groups will be ignored. Example (urlencoded): ?groups=CC+Newsletter:CC+Events
  • pcpid (optional): If this contribution originated from a Personal Campaign Page (PCP), this is the CiviCRM database ID of the PCP page. Example: ?pcpid=8
  • premium (optional): If the user has opted for a gift/premium, this is the CiviCRM database ID of the premium they will get. Example: ?premium=12
    • size (optional): If the premium includes a t-shirt, this is a free-text description of the size. This option is ignored if premium is not set. Example (urlencoded): ?size=Adult+Large
  • receipt (optional): This is the database ID of the message template to use when generating a receipt email to the contributor. These are the message templates found in CiviCRM at CiviCRM -> Administer CiviCRM -> Configure -> Message Templates. This functionality allow you to send a different receipt message based on various criteria, whatever they may be. You can use any, all or none of a few variable tokens in the templates. They are pretty much self-explanatory and they are these:
    • %{amount}
    • %{date}
    • %{trxn_id}
    • %{first_name}
    • %{last_name}
  • return (optional): This is the URL the contributor will be directed to if/when they click on some link directing them back to your site after having completed the transaction. Will always have a predefined default value should it not be passed. Example (urlencoded): ?
  • recur (optional): Defines whether this is to be a recurring contribution, and if so of what type. A passed value of 1 means that the amount will charged to the contributor's account every month for 12 months. A passed value of 2 means that the amount will be charged to the contributor's account every month indefinitely. Example: ?recur=1
  • sloptout (optional): This is a Creative Commons-specific field. You can ignore it. If this variable is present in the request the contributor's name will not be included in the public supporter list on the CC support site. If the contribution originated from a PCP, the contributor will not show up in the "honor roll" list on the PCP page. The value doesn't matter. If this variable is not passed, the contributor's name will by default be displayed in public supporter listings. Example: ?slopout=LOL
  • source (optional): When the contributor is sent to the payment processor there is a description displayed letting them know what the payment is for. If this value is passed it will be the text that is displayed to the contributor. It is also the text that will be stored in the CiviCRM contribution field "Source," so it can used to identify where the contribution originated such as from the CC Network, a regular donation, a donation widget, etc. A default value is set in the script which will be used if this variable isn't passed. Will always have a predefined default value should it not be passed. Example (urlencoded): ?source=CC+Network+Annual+Membership

Sweeping up with ContributionProcessor.php

The OneClick system relies 100% on the successful processing of IPN/notifications from the payment processor. This should normally be nearly 100% reliable, but if for some unforeseen reason it fails, then one can always use the CiviCRM script bin/ContributionProcessor.php to pull down contributions from the payment processor and record them in CiviCRM.

You could, for example, run ContributionProcessor.php once a day, or once a week, just to be sure, though it probably isn't necessary. If you choose to run bin/ContributionProcessor.php periodically to pull new contributions into CiviCRM, your crontab entry will probably look something like:

*/15 * * * * wget -O - -q -t 1 " \
/default/modules/civicrm/bin/ContributionProcessor.php?name=my_user& \
pass=my_pass&key=XXXXXXXXXXXXXXXXXXXXXXXX&ppID=5&ppMode=live&type=paypal" &> \
/dev/null; wget -O - -q -t 1 " \
/modules/civicrm/bin/ContributionProcessor.php?name=my_user&pass=my_pass& \
key=XXXXXXXXXXXXXXXXXXXXXXXXX&ppID=7&ppMode=live&type=google" &> /dev/null

Related Links

car games