PayPal Standard Configuration¶
What is the basic business idea of paypal?
Every user has his account with paypal where he has some money he can use to pay online, using various means like e-mail, web etc. Once a user has a paypal account he cannot do transactions with paypal without logging into his account.
Beware: If your account has some unresolved conflicts it will not let you do things you want but will just show the account overview where you could select the next actions.
Note for registered non-profits: If you start a non-profit account with Paypal you must provide acceptable documentation to Paypal of your legal status as a non-profit, or Paypal will disable your account.
What is the principle of using a sandbox at paypal?
They have tried to use exactly the same software as the live system with the same screens and behaviour. To enter the sandbox you first log in to your paypal developer account, then select a test user (the role depends on your needs) and enter the sandbox. From then on you are like a user in the live situation.
PayPal Website Payments Standard¶
- Log into CiviCRM as an administrator.
- Select Administer CiviCRM >> Global Settings >> Enable Components
- Ensure that CiviContribute is enabled.
Add a Payment Processor
- Select Administer CiviCRM >> Global Settings >> Payment Processors
- Click » New Payment Processor
- Select PayPal - Website Payments Standard for Processor Type.
- Enter into Merchant Account Email Address the email which is used for your Paypal account for live transactions.
- Enter the Merchant Account Email Address** linked to your PayPal Sandbox merchant account (e.g. *email@example.com ) in the *Processor Details for TEST Payments** section, if you are using a testing sandbox. If not, enter the same email address as the step above.
- If you'd like to process live payments on the site, you can generally accept the default values for Site and Button URLs.
Note: If you are still developing the site, and would like to test the work-flow on the site (and accept no live payments), copy the "Test Payments" values to the "Live Payments" section.
Note: If you see an API URL field for Paypal_Standard, you can ignore it.
Assign this Processor to your Contribution or Event Registration Page(s)¶
You must assign your new Payment Processor to your Contribution Page or Event Registration before you can test-drive them.
- For Contribution Pages - go to Manage Contribution Pages » Configure » Title and Settings and select your Website Standard processor, then click Save.
- For Event Registration - go to Manage Events » Configure » Event Fees and select your Website Standard processor, then click Save.
Enabling Recurring Contributions¶
If you are using PayPal Website Payments Standard - you can give users the option to make a recurring contribution on any of your Contribution Pages.
- Administer CiviCRM » Manage Contribution Pages
- Click Configure for the page where you want to enable recurring contributions
- Click Contribution Amounts
- Check the Enable recurring payments box.
Configure Paypal to Talk to CiviCRM¶
CiviCRM can receive feedback from Paypal after the contribution is made. This requires making some changes within your Paypal account Profile at https://www.paypal.com
Instant Payment Notification¶
- To configure Instant Payments Notification (IPN) for your PayPal account Click: Profile, under Selling preferences click "Instant Payment Notification preferences"
- Enable Instant Payments Notification (Select "Receive IPN messages (Enabled)")
- Your specific IPN will vary with you domain address, your CMS, and which payment processor ID CiviCRM has for this PayPal processor. Use the approach at IPN Notify URL to determine the right address, then put in as the Notification URL. (CiviContribute will also pass the exact IPN 'listener' URL to PayPal automatically during each transaction, but there are reports in June 2019 this was insufficient.)
- Click Save
If you are still using the deprecated https://example.com/civicrm/extern/ipn.php you should switch to the standard CiviCRM URL as detailed at IPN Notify URL
Then Set the Auto Return So the Contributor Goes Back to Your Site¶
- Click: Profile > My Selling Tools > Website Preferences > Update
- Set Auto Return to On
- Enter your CiviCRM site home page as the Return URL. This is a placeholder. CiviContribute will pass the exact return URL to PayPal automatically during each transaction.
- Set "Payment Data Transfer" to "Off"
- Click Save
Creating A Testing Sandbox Account at Paypal Developer Central¶
If you don't have an Developer Central account, follow PayPal instructions to register a developer account and create a sandbox (test) merchant account.
Launch your merchant sandbox¶
Login as your Developer Central account (e.g. firstname.lastname@example.org ) and create two new "sandbox" accounts. "Create Account:" -> "Preconfigured"
- Create a "seller" - this is your website. E.g. email@example.com
- Create a "buyer" - this is your test donor/customer. E.g. firstname.lastname@example.org
Configure CiviCRM with the "seller". Use the "buyer" to test the site. If you "reset" the seller account, be sure to repeat these steps.
Profile >> Instant Payment Notification Preferences¶
From your Developer central account (e.g. email@example.com ) at https://developer.paypal.com
- Test accounts -> Select the "seller" account (e.g. firstname.lastname@example.org ) -> Click "Enter Sandbox Test Site" -> Login
- You should now be at https://www.sandbox.paypal.com/...
Contributions remain in PENDING status¶
In order for contributions to be marked as COMPLETED, PayPal's Instant Payment Notification (IPN) must post back to CiviCRM an acknowledgement that the contribution was completed. In order for this to happen, your CiviCRM site must be accessible on the public internet (i.e. not running on localhost or behind a firewall). Interactions with PayPal IPN are logged to a file called CiviCRM.log or CiviCRM.<33char string>.log located in your configured Temporary Files Directory (
One issue when using the Paypal test account is that you sometimes need to confirm your payments in PayPal- possibly only when dealing with multiple currencies. If you see a message in the CiviCRM.log file:
[info] returning since contribution status is pending.
If this is the case:
- Log into into your test PayPal account:
- On the overview page you will see that the payment will be in an Unclaimed status - click Accept in the Order status/Actions column.
The IPN will be resent and you should get a message similar to:
[info] Contribution record updated successfully [info] Success: Database updated and mail sent
From civicrm 4.5 a copy of any IPNs received will be in the civicrm_system_log table. If the IPN was not received at all (e.g server outage) you can resend them while logged into your paypal account
- Go to 'Profile' and then under 'Selling Preferences' you should see 'Instant Notification Preferences'
- On the Instant Notification page you get to you should see a link to 'IPN History Page'
- Search for the missed IPNS (up to 28 days ago), select them all & click resend
- TIPS - you don't have to worry about oversending - if you select some that were already received no harm done (despite the scary message). Also, at the bottom of the page you can change to select more than 25 at once to reduce your effort
Unexpected errors from PayPal¶
Occasionally there are technical / availability problems with the PayPal Sandbox servers. You can check Sandbox status here.
Turning on Taxes in PayPal causes payments to remain pending¶
If you change the PayPal setting so that PayPal calculates and adds taxes, then the total amount charged by PayPal will no longer match that in CiviCRM. When PayPal calls back to CiviCRM saying it has received payment for $Total including taxes this doesn't match CiviCRM's $Total that excludes taxes. If you check your CiviCRM log file (generally under files/civicrm/ConfigAndLog/) you'll find an error similar to
Nov 04 10:12:57 [info] Amount values dont match between database and IPN request
The solution is to turn off the PayPal Sales Tax option.
Sales tax support is added to core in v. 4.6, and there is a Canadian Sales Tax extension available. Feel free to contact Joe (dot) Murray (at) JMAConsulting (dot) biz for advice on how to create an extension for your jurisdiction if need be.