PayPal Module

Installing Payment Gateways

Follow the installation steps to get started.

Configuring the PayPal Gateway

PayPal can be configured quickly and easily after installing the PayPal module by doing the following:

  1. Install the PayPal Gateway module
  2. Go to Directory → Settings → Payment
  3. At the top, check Enable Payments.
  4. Click on the PayPal sub-tab
  5. Check the box to activate the PayPal gateway option
  6. Enter your PayPal business account email
  7. (Optional, but recommended) Put the payment gateways in test mode. Uncheck this when done testing!
  8. Change your currency, if applicable
  9. Change currency display options, if you want
  10. Turn on the abandoned cart emails, if desired
  11. Save settings
  12. Create one or more plans
  13. Update your IPN settings in PayPal (see below under Recommended PayPal settings)
  14. You’re ready to test payments. Log out as Administrator and attempt to place a listing–verify that it goes through. NOTE: Payments will not be taken if you are logged in as the administrator!
IMPORTANT: Once you’re done testing, be sure to Uncheck “Put gateways in test mode” so you can accept real payments.

Once correctly configured, your payment options and PayPal configuration will look like this for the Payment → PayPal settings.

Yours will have your PayPal email and your Merchant ID from your PayPal business account, if applicable.

IMPORTANT: The merchant ID is required to create the “Unsubscribe” buttons inside the Manage Recurring payments screen. If recurring payments are not being used or you don’t want users to be able to click a PayPal button to cancel their subscription, then the Merchant ID is not needed.

The remaining settings including currency code and currency code placement are left up to you, depending on your preferences and needs.

You can also configure payment reminders for those who attempted to place a listing, but never complete the process (“Abandoned Cart Emails”):

And lastly, if you have the Discount Codes module installed, you can activate whether to allow discounts for listing purchases here as well.

NOTE: In order to accept credit cards as a payment option, OR to allow for Recurring Payments, you must have a PayPal Business or Premier account. A Personal PayPal account will allow you to accept payments via PayPal but not take credit cards or recurring payments.

ALSO NOTE: If you already have an IPN set up for another site, you don't need to create a new one for BD. It doesn’t matter what URL you insert since the Business Directory PayPal Module will override it. We will take the existing IPN URL and use it as a “template”. We will send the proper URL with the payment info (constructed by us using that existing IPN one as a template). But we have to have an IPN URL configured to start with. You can literally just use your site's homepage URL if you want, we'll do the rest.

We recommend applying the following modifications to your PayPal account’s settings in order to properly integrate with BD during the checkout and payment steps.

Enable Instant Payment Notifications (IPN) notifications

In order for your collected payments to get correctly marked as paid, you must configure your PayPal business account to send payment notifications. Follow the directions below to set this up.

  1. Log into your PayPal account.
  2. Click the gear icon at the top right section of the page and select Account Settings.
    Paypal IPN Account
  3. From the left sidebar menu, select Website Payments and click the Update link right next to ‘Instant payment notifications'.
  4. Click the Choose IPN Settings button.
    Paypal IPN Settings
  5. Enter a notification URL, select Receive IPN messages (Enabled), and hit Save. You can use any URL you'd like, since each payment sets the notification independently. If this URL is already set, feel free to leave it as is.
    Paypal IPN Email

If you would like more information about instant payment notifications, see the PayPal IPN's page.

Disable Payment Data Transfer (PDT)

  1. Login to
  2. Click your name in upper right corner.
  3. Choose Account Settings.
  4. Chose Website Payments.
  5. It will take you to the Website payment preferences page.
  6. Disable Auto Return (Set to Off).
  7. Disable Payment Data Transfer (Set to Off).
  8. Click Save.

Now you should be ready to receive payments via PayPal!

Testing PayPal Payments

  1. Create both a personal and business PayPal account at
  2. Set up the instant payment notifications (IPN) on your business sandbox account (described above).
  3. Go to Directory → Settings → Payment and enable the Put payment gateways in test mode? option.
  4. Next, go to Directory → Settings → Payment → PayPal and insert the email address in the PayPal Business Email that is associated with your business sandbox account.
  5. Run a test transaction and pay using your personal sandbox email.
If you need more information, you may refer to these resources provided by PayPal:

Related Articles