QUTCapstone2020-Payment-Plugin

• What is this?
• Why design a payment plugin?
• Repositories
• Version requirement
• Installation
• How to use these plugins?
• PayPal payment gateway subplugin
• Support

What is this?

This is a moodle plugin which adds a Paypal/credit card payment gateway to your courses.

Why design a payment plugin

There are currently no easy to use payment plugins within the moodle plugin directory. Plugins that allow an admin to lock a course behind a payment already exist:

(Default moodle intergrated Paypal payment gateway) https://github.com/moodle/moodle/tree/master/enrol/paypal.

(Moodle payment software run through https://stripe.com) https://moodle.org/plugins/enrol_stripepayment.

However, the major difference between our software and the two examples listed above is the flexibility of our plugin. This plugin can accomodate for multiple payment gateways through the use of subplugins.

Repositories

There are currently two required repositories to make this plugin work.

The repository that is responsible for setting up the gate ways and managing all the data:

https://github.com/Peterburnett/QUTCapstone2020

The other repository responsible for displaying the website hook:

https://github.com/Peterburnett/QUTCapstone2020-enrol

Version requirement

To run this plugin with the enrolment plugin (https://github.com/Peterburnett/QUTCapstone2020-enrol), the enrolement plugin need to be atleast at version 2020082600. The enrolment plugin requires a payment plugin version to be 2020042101+.

Installation

Step 1: Installing the plugin

Download the .zip file the from the master https://github.com/Peterburnett/QUTCapstone2020.

Extract this into /yourmoodle/admin/tool/paymentplugin/

Step 2: Installing the enrolment plugin

Download the .zip file from the master https://github.com/Peterburnett/QUTCapstone2020-enrol.

Extract this into /yourmoodle/admin/enrol/payment

Step 3: Upgrading moodle

Then run the moodle upgrade as normal.

https://docs.moodle.org/en/Installing_plugins

How to use these plugins

1. Enable the enrolment plugin.
2. Add an instance of the enrolment plugin to a course that will require payment.
3. Set the course price from Course Administration -> Payment Settings.
4. In the admin tool plugin settings, enable payment gateways that the students will be able to use.
5. Change admin tool plugin settings and payment gateway subplugin settings as necessary.
6. The course will now display a button to unenrolled students, redirecting them to a page where the course can be purchased through the payment gateways.

PayPal payment gateway subplugin

The admin tool plugin comes with a PayPal subplugin pre-installed. This subplugin requires the admin to have a PayPal business account.

Support

This plugin was developed by QUT MAHQ Developers as a Capstone project. Haruki Nakagawa - harukinn(at)icloud(dot)com Quyen Nguyen - qnguy29(at)gmail(dot)com Aaron Dang - aarondang(at)hotmail(dot)com Mitchell Halpin - mhalp1406 (at) gmail (dot) com

With the support of Catalyst IT Australia: https://www.catalyst-au.net/