Note: All pages below are subject to having relevant Roles and Permissions.
In this guide we will cover how to set up and configure ParentPay Integration.
There are currently two methods within the MIS for enabling ParentPay Integration;
- The old method is to connect via the ParentPay Integration option within Config>Setup, or connect via Third Party API’s.
- The new method is to connect via Third Party API’s by creating a Third Party Access Account.
From September 2021, we recommend that Schools use the new method. Both options are detailed below;
Connecting via built in ParentPay Integration (Old Method)
Note: Schools that have purchased ParentPay Integration before the 21/22 Academic Year will use this method.
Hover on the Config heading on the Menu select Setup and click on ParentPay Integration Settings.
To setup the ParentPay Integration please follow the steps below. If you get a message ParentPay Integration is not licensed please contact email@example.com
This will open the Parentpay Integration Settings page.
Enter the School ID from ParentPay which you will find in the top right hand corner of the ParentPay homepage into the Supplier ID field.
You will need to create an Admin Account in ParentPay for Bromcom. Add the Account Credentials to the Username and Password fields.
You can also decide which if any of the Medical and Dietary Needs are uploaded for the ParentPay Export Data. These can be selected individually using the Ctrl key or all can be selected by ticking the upload all medial conditions/dietary needs box.
Click Save when finished.
You can then either manually upload or set a schedule to run once a day at a time you want. Just toggle the Schedule Enabled radio button and set the time you want it to run.
Connecting via Third Party API’s (New Method)
Note: Schools who are looking to use this product from September 2021 onwards should use this method.
As well as the built in Integration offered within Config>Setup>ParentPay Integration, ParentPay now also support Integration via Third Party Access Accounts using API’s.
In order to set this up, you would need to go to Modules>Settings>System Users and once this page loads, press New.
This will open the User Account creation screen where you need to select Create a new user.
This User Account will sit in the MIS alongside your other User Accounts, so please make sure you name it appropriately to make it stand out (For example, First Name – Parent, Last Name – Pay).
The Username and New Password fields are required, but they will NOT be used by ParentPay to log in to the system. These are only used to log in by Staff Members, ParentPay will not log in the same way so do not share this information with them.
Note: Please consider that the Username determines how the account will be displayed in later stages.
Once all of the required details have been entered, the next step is to scroll down and enable the Third Party Role.
Note: Please ONLY enable the Third Party Role for the ParentPay account, as this Role is specifically created to only allow ParentPay to see data they need. Enabling other Roles can make sensitive data elsewhere accessible so please do not do this.
Once this is done, scroll back to the top and press Save.
This step is now complete and the next step is to go to Modules>Setup>Third Party Access Permissions and Logs.
Select the ParentPay Third Party Account from the drop down.
This will open up the logs for the account, and will provide the option to Manage Permissions as seen below;
This list of Permissions is very important and determines exactly what data ParentPay are able to read/access.
Note: The required Permissions are specified entirely by ParentPay themselves, and are subject to change by them. Below is a copy, however we do advise that when you setup the integration you ask for the latest Permissions.
Once you have enabled all of the required Permissions, ensure to press Save and the process should be complete.
ParentPay may not immediately see your MIS data, but if there are no logs for the account the following day you would need to contact ParentPay to troubleshoot beyond this point.