Note: You are currently viewing documentation for Moodle 2.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Paypal enrolment.

Paypal enrolment: Difference between revisions

From MoodleDocs
(Setup Steps: Moodle Course Enrollment & Paypal)
 
(35 intermediate revisions by 10 users not shown)
Line 1: Line 1:
Location: PayPal edit settings link in ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0
{{Enrolment}}
The PayPal enrolment plugin allows users to pay for courses and then be automatically enrolled.  


==PayPal account creation==


The PayPal enrolment plugin allows you to set up paid courses. It may be enabled via ''Site administration > Courses > Enrollments''.  You can use the edit link to set a standard course cost default.
# Go to https://www.paypal.com and create a Paypal account. Not required but recommended for selling: Upgrade your account to "Premier" status and get "Verified"
# Set the Encoding to UFT-8. In Paypal, go to ''Profile > Profile & Settings > My Selling Preferences (from left menu) > Paypal button language encoding'' (at the bottom of the page under More Selling Preferences) and set your website's language (like select "Western European Languages (including English)" as it is the only English version)Then click on the "More Options" button and set the Encoding to "UTF-8", select "Yes" to use the same encoding for data sent from Paypay to you, and save.
# Optionally setup IPN in Paypal to interact with Moodle.  Log into Paypal, go to "Profile > Instant Payment Notifications (IPN)”, click "Turn On IPN", click the "Edit settings" and enter a URL that references your IPN file in your Moodle installation (for example: http://<domain name>/moodle/enrol/paypal/ipn.php)


==Setup Steps: Moodle Course Enrollment & Paypal==
==Enabling PayPal enrolment==
The following steps are based on '''Moodle release = '1.9.5+''' (Build: 20091007) and Paypal as of Feb 2011.


'''In Moodle:'''
An administrator can enable PayPal file enrolment as follows:
* Create a course
* After the course is complete, from the main Moodle page (after logging in as an Administrator) click on the course name and then click on "Settings" on the left navigation bar.  In the new page that appears, do the following:
# Scroll down to the "Enrolments" section  and fill it out:
## Enrolment Plugins: Paypal
## Default role: Site Default (Student)
## Course enrollable: Yes
## Enrolment duration: 30 days (or whatever you want)
# "Enrolment expiry notification" section (these settings are optional but it is always good to communicate):
## Notify: Yes
## Notify students: Yes
## Threshold: 10 days
# "Availability" section
## Availability: "This course is available to students"
## Enrolment key: <left blank>  (not required; optional)
## Guest access: "Do not allow guests in"
## Cost: enter a price (like 100.00) and select currency (like "US Dollar")
# Save changes


* Now on the main Moodle page after logging in, it should list your course with a price under it.
# ''Go to Site administration > Plugins > Enrolments > Manage enrol plugins'' and click the eye icon opposite PayPal. When enabled, it will no longer be greyed out. Manual enrolment must also be enabled, since the PayPal plugin requires it.
# Click the settings link, configure as required (see details of settings below), then click the 'Save changes' button.


Setup email based self-registration
* PayPal business email - This setting is case sensitive and must exactly match that in PayPal
* Log into Moodle as the Administrator
* Default role assignment - This means the role that a new user will automatically be given in a course when they purchase access. Usually this would be "student" unless you have a special reason for choosing another role. As for other default settings, it may be overridden in individual courses.
* Select "Site Administration > Users > Authentication > Manage Authentication"
# Enable "Email-based self-registration" (make sure the eye appears next to this)
# Scroll down and fill in the rest of the fields
## Self registration: "Email-based self-registration"
## Guest login button: Hide
## Restrict domains when changing email: checked
## Fill in ReCAPTCHA keys (go to http://recaptcha.net and fill out the form to create an account; it will then provide you with the public key and the private key to use on this form)
## All other fields are blank
## Save Changes


* Now select "Site Administration > Users > Authentication > Email-based self-registration"
Tip: If you wish to allow users to create their own accounts on your site then you need to set up [[Email-based_self-registration|Email based self registration]].
# "Enable reCAPTCHA element": Yes
# All other fields: Unlocked


* Now select "Site Administration > Courses > Enrolments"
==Course settings for Paypal==
# PayPal enabled, set to Default
# "Send course welcome message": Yes
# PayPal Edit button:
## Provide an enrolment cost (this is a global cost, individual course costs defined in the step above will override this setting), currency and your personal/business email
## Check all the checkboxes so that emails are sent
## Save changes


'''In Paypal:'''
===Checking you have Paypal in your course===
* Setup your PayPal account at paypal.com
# Create a Paypal account
# Not required but recommended for selling: Upgrade your account to "Premier" status and get "Verified"
# Setup IPN in Paypal to interact with Moodle.  Log into Paypal, go to "Profile > Instant Payment Notifications (IPN)”, click "Turn On IPN", click the "Edit settings" and enter a URL that references your IPN file in your Moodle installation (for example: http://<domain name>/moodle/enrol/paypal/ipn.php)
# Set the Encoding to UFT-8.  In Paypal, go to "Profile > Language Encoding" (under the Selling Preferences column) and set your website's language (like select "Western European Languages (including English)" as it is the only English version).  Then click on the "More Options" button and set the Encoding to "UTF-8", select "Yes" to use the same encoding for data sent from Paypay to you, and save.


* Do not use a PayPal button on your website
# In a course, go to ''Administration> Course administration > Users > Enrolment methods''
# Instead, on your website provide a link to your main login page for your Moodle installation.  It will now have a section on the right for 'firt time users' with a "Create new account" button.  This is how the process will start now.
# If you do not see PayPal, use the pull down menu "Add method" and select PayPal.
# Make sure PayPal has its "eye" opened:


'''Workflow -''' Now the workflow goes like this:
[[File:Paypalenrolmentmethod.png]]
* On your website links to the main login page for Moodle (looks something like: http://<domain name>/moodle/login/index.php)
* Click the "Create new account" button
# Fill in the form (this is the "Email-based self-registration" form with the reCAPTCHA at the bottom) and click the "Create my new account" button
# You will get a web page saying to check your email for instructions on completing your registration.
* Log into your email and you should have an email.  It will have a URL to click in order to confirm the new account.  Click it.
* A new Moodle page will appear saying "Thanks, <name>" "Your registration has been confirmed"
# Click the "courses" button


* Now it lists all the courses available.  When you click on one of the course names that you want to take, it brings you to a page that has the course summary and the price displayed. Below this is another section that says "This course requires a payment for entry", shows the price and now has a PayPal button that says "Send payment via PayPal".  Clicking this sends you to PayPal with the course listed in the order summary and you can log in to pay. 
Note: Make sure you don't have [[Self enrolment]] enabled as this would allow users to access the course without paying. If you do need some users to self enrol for free, then add an enrolment key in the self enrolment settings.
# Once done paying you will receive an email confirmation and a link to the main Moodle login page that you provided in the Paypal setup.
# The user should be able to log in now to take the purchased course.
# Likewise you will have received emails from Paypal on the purchase and the user/student will have received a confirmation receipt from Paypal also.


===Setting a price for your course===


==Course costs==
# In ''Course Administration > Users > Enrolment methods'', click the edit/hand/pen icon to the right of the PayPal option.  
Costs for each course can be set separately. If the cost for any course is zero, then students are not asked to pay at the time of enrolment into the course. However, if there is a site wide default course cost, you may override that in your course settings.
# Optional: Give a name to this enrolment method if you wish in "Custom Instance name"
# Ensure that "Allow PayPal enrolments" is set to "yes"
# In "Enrol cost", type in the cost of your course and in "Currency" choose your currency.
# Usually you would leave the "Assign role" as "student" unless you have a very special reason for allowing your users to enrol as, say, editing teachers etc
# Choose an enrolment period and/or start/end dates if desired.
# Click the "Save changes" button.


If the course cost field is not empty, then students trying to enrol will be presented with the option of making a payment to enter.
[[File:Paypalcoursesettings.png]]


If you ALSO enter an [[Enrolment key|enrolment key]] in the course settings, then students will also have the option to enrol using a key. This is useful if you have a mixture of paying and non-paying students.
===What the new user sees===


==Verifying the default encoding==
When a new user clicks on your course link, they will see a message inviting them to go to PayPal to purchase access to the course. In the list of courses, PayPal courses have a dollar sign icon next to them.
{{Moodle 1.8}}If you are using Moodle 1.8 or later, you need to verify the default encoding in your PayPal business account as follows:


#Login go to your PayPal account, select "My Account" tab, then Profile tab.
{|
#Click on "Language Encoding" in the right column Selling Preferences.
| [[File:Paypaluserview.png|frame|left|Message inviting user to pay via PayPal]]
#Click on "More Options" button and select UTF-8 encoding for both cases. If you are using other software with IPN please check that it is compatible with UTF-8 encoding.
| [[File:Paypalicon.png|frame|left|PayPal course listed with dollar sign icon]]
|}


==See also==
==Changing the dollar symbol==
[[File:PaypalGBP.png|frame|PayPal course listed with GBP sign icon]]
The default currency symbol for PayPal is a dollar sign. If you are using GBP or Euros or another currency, you can change this by creating your own customised icon with your choice of currency. Make it 16x 16 pixels and call it ''icon.gif''  Upload your new icon via FTP to your  ''moodle directory>enrol>paypal>pix''. Your icon.gif will override the dollar sign. Make sure you refresh your page to be sure of the changes.


* Using Moodle [http://moodle.org/mod/forum/view.php?id=2981 Enrolment Plugins forum]
==PayPal capabilities==
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=137299 Can't get paid enrollment to work in any form] forum discussion
 
*[[Metacourses]] - using same core course subjects but packaging them at different rates.
*[[Capabilities/enrol/paypal:config|Configure PayPal enrol instances]]
* see Jhon Anderson's  answer in the forums [http://moodle.org/mod/forum/discuss.php?d=116279#p510221 Howto setup Moodle to work with Paypal]  
*[[Capabilities/enrol/paypal:manage|Manage enrolled users]]
*[[Capabilities/enrol/paypal:unenrol|Unenrol users from course]]
*[[Capabilities/enrol/paypal:unenrolself|Unenrol self from the course]]


[[Category:Enrolment]]
[[fr:Inscription par Paypal]]
[[fr:Inscription par Paypal]]
[[de:Paypal-Einschreibung]]
== See also ==
*[http://moodle.org/mod/forum/discuss.php?d=171745#p977221 Testing the PayPal plugin in the PayPal Sandbox]
[[es:Inscripción por Paypal]]

Latest revision as of 10:53, 19 May 2016

The PayPal enrolment plugin allows users to pay for courses and then be automatically enrolled.

PayPal account creation

  1. Go to https://www.paypal.com and create a Paypal account. Not required but recommended for selling: Upgrade your account to "Premier" status and get "Verified"
  2. Set the Encoding to UFT-8. In Paypal, go to Profile > Profile & Settings > My Selling Preferences (from left menu) > Paypal button language encoding (at the bottom of the page under More Selling Preferences) and set your website's language (like select "Western European Languages (including English)" as it is the only English version). Then click on the "More Options" button and set the Encoding to "UTF-8", select "Yes" to use the same encoding for data sent from Paypay to you, and save.
  3. Optionally setup IPN in Paypal to interact with Moodle. Log into Paypal, go to "Profile > Instant Payment Notifications (IPN)”, click "Turn On IPN", click the "Edit settings" and enter a URL that references your IPN file in your Moodle installation (for example: http://<domain name>/moodle/enrol/paypal/ipn.php)

Enabling PayPal enrolment

An administrator can enable PayPal file enrolment as follows:

  1. Go to Site administration > Plugins > Enrolments > Manage enrol plugins and click the eye icon opposite PayPal. When enabled, it will no longer be greyed out. Manual enrolment must also be enabled, since the PayPal plugin requires it.
  2. Click the settings link, configure as required (see details of settings below), then click the 'Save changes' button.
  • PayPal business email - This setting is case sensitive and must exactly match that in PayPal
  • Default role assignment - This means the role that a new user will automatically be given in a course when they purchase access. Usually this would be "student" unless you have a special reason for choosing another role. As for other default settings, it may be overridden in individual courses.

Tip: If you wish to allow users to create their own accounts on your site then you need to set up Email based self registration.

Course settings for Paypal

Checking you have Paypal in your course

  1. In a course, go to Administration> Course administration > Users > Enrolment methods
  2. If you do not see PayPal, use the pull down menu "Add method" and select PayPal.
  3. Make sure PayPal has its "eye" opened:

Paypalenrolmentmethod.png

Note: Make sure you don't have Self enrolment enabled as this would allow users to access the course without paying. If you do need some users to self enrol for free, then add an enrolment key in the self enrolment settings.

Setting a price for your course

  1. In Course Administration > Users > Enrolment methods, click the edit/hand/pen icon to the right of the PayPal option.
  2. Optional: Give a name to this enrolment method if you wish in "Custom Instance name"
  3. Ensure that "Allow PayPal enrolments" is set to "yes"
  4. In "Enrol cost", type in the cost of your course and in "Currency" choose your currency.
  5. Usually you would leave the "Assign role" as "student" unless you have a very special reason for allowing your users to enrol as, say, editing teachers etc
  6. Choose an enrolment period and/or start/end dates if desired.
  7. Click the "Save changes" button.

Paypalcoursesettings.png

What the new user sees

When a new user clicks on your course link, they will see a message inviting them to go to PayPal to purchase access to the course. In the list of courses, PayPal courses have a dollar sign icon next to them.

Message inviting user to pay via PayPal
PayPal course listed with dollar sign icon

Changing the dollar symbol

PayPal course listed with GBP sign icon

The default currency symbol for PayPal is a dollar sign. If you are using GBP or Euros or another currency, you can change this by creating your own customised icon with your choice of currency. Make it 16x 16 pixels and call it icon.gif Upload your new icon via FTP to your moodle directory>enrol>paypal>pix. Your icon.gif will override the dollar sign. Make sure you refresh your page to be sure of the changes.

PayPal capabilities

See also