This article will show you how to set up our two-way integration between Arbor and the Caterlytix cashless catering system for student and staff meal payments. The integration ensures payment information for meals is up-to-date in both systems with no need for double entry, and you can top up and reconcile accounts in both Arbor and Caterlytix.
- For parents, the Parent Portal and Arbor App becomes their single point of access for making top ups and checking balances, without needing to jump into a different system.
- Save time - no need to update and log in and out of multiple systems.
- Easy reconciliation - balances are automatically copied between systems in almost real time.
- Automate account balance updates - when a child pays for their meal, the price is automatically deducted from their account balance in Arbor.
Before you get started
Permissions
- School: User Accounts: Administer - Approve the API connection
- Integrations: Administer All Integrations - Access the Integrations Administration page to set up the integration in Arbor
- Finance: Administer - See the button to set up the integration in Arbor, manage payments in Arbor
If you don't have the permission, you'll need to ask your admin team to give you permission using these instructions.
VeriCool Integration
If you are or were using VeriCool in this integration, please refer below:
If you are moving to ArborPay and are already using VeriCool, your opening balances must be sent up from VeriCool to Caterlytix, who will then upload them into ArborPay. Please ensure you do not add any starting balances in Arbor, as this could potentially duplicate the balances.
If you already use ArborPay before implementing VeriCool, Caterlytix will obtain the balances directly from ArborPay, and VeriCool will import those balances into the Caterlytix system using the balance export provided by the school.
Setting up the integration
Step 1 - Let Caterlytix know you want to use Arbor with their cashless catering system
You'll first need to contact Caterlytix (support@caterlytix.com) to let them know you'd like to integrate your cashless catering system with Arbor Payments.
If you’re switching from another online payment provider, for example ParentPay, it’s important to also notify them of the move if you haven’t already.
Step 2 - Check current data in both systems
Ensure the data in Caterlytix' system is sufficient and up-to-date, i.e transactions are present and balances are correct. Also check whether you have any existing meal account balances in Arbor.
If you’re switching from another online payment provider, make sure that parent access to your previous payment system has been disabled and that all payment transactions have been synced to Caterlytix.
Step 3 - Approve the API connection between Groupcall and Arbor
Caterlytix uses Groupcall to sync student and staff profiles from Arbor to Caterlytix. If you have not already approved the Groupcall connection at your school, please contact them to get this set up and follow this article.
Step 4 - Approve the API connection between Caterlytix and Arbor
The Trac by Caterlytix app is used to synchronise data between Arbor Payments and Pebble Till, via Arbor’s Payments API.
Navigate to this URL https://developers-portal.arbor.sc/integration/authentication/2465, sign in using your Arbor credentials and approve the Trac by Caterlytix app.
You can check that the Trac by Caterlytix app has been approved successfully by going to System > Partner Apps (API Users) and clicking on the Approved Apps page.
Step 5 - Set up the integration in Arbor
Once API access has been approved, go to School > Data > Integrations Administration and click the Set up cashless catering integration button.
In the slide over, select Caterlytix Cashless Catering as the provider and click Proceed with setup.
On the next page, you will be asked to confirm that student and staff data is already synchronised between Arbor and Caterlytix. If this isn’t already synchronised, Caterlytix will do this for you when they enable the integration at their end, so choose “Yes, synchronisation of student and staff data is already set”.
You also need to select the Customer Account Type that you wish to use for the synchronisation - we recommend your Meals account. Only payments for this Customer Account Type will be synced.
Once you have completed the process correctly, it will appear as Enabled on the Integrations Administration page.
Step 6 - Temporarily disable Parent Portal payments
When Caterlytix is setting up the integration, you'll need to ensure that there are no payments being made through Arbor.
You can temporarily disable access to top up the Meal accounts by going to School > Payments > Setup > Customer Account Types. Click into the Meal account, click Edit then untick Show in parent portal.
Step 7 - Caterlytix perform the final steps of integration
Contact Caterlytix to let them know that you have approved the Trac by Caterlytix app and are ready for the integration to be fully enabled on their end. This is important as Caterlytix will need to complete some work to set up your Arbor system with Trac by Caterlytix.
Caterlytix will send the “opening balances” to Arbor based on the balances of the accounts in Caterlytix' system.
Step 8 – Re-enable Parent Portal payments
Once Caterlytix confirm with you that they have completed the setup, you can now re-enable the account to show for parents by going to School > Payments > Setup > Customer Account Types. Click into the Meal account, click Edit and tick Show in parent portal. Parents will now be able to top up their child’s meal account via Arbor and top-up transactions will begin syncing with Caterlytix.
Using the integration in Arbor
- How payments will show in Arbor - All incoming transactions will have the Payment Method and Narrative set to Cashless Catering System so you can identify where the transactions have come from: How do Cashless Catering payments show in Arbor?
- How payments will show on the Parent Portal - When logging into the Parent Portal, guardians will see their Cashless Catering account balance on the main dashboard, which they can click into: How do Cashless Catering payments show on the Parent Portal?
FAQ
Can Pebble Till Cashless Catering be integrated with multiple payment systems at the same time (e.g. Arbor and ParentPay)?
No, Pebble Till Cashless Catering can only be integrated with one payment system at a time, so you cannot do a phased roll out. If you have previously integrated with another payment system (e.g. ParentPay), this must be disabled before integration with Arbor can be enabled.
Can multiple Customer Account Types be synchronised with Pebble Till Cashless Catering?
No, only one Customer Account Type (typically the Meals account) can be configured to synchronise with Pebble Till Cashless Catering.
Can I change the Customer Account Type once it has been set up?
No, once integration has been enabled, you are unable to change the Customer Account Type. This is to ensure that all transactions are kept in sync and there is no loss of information.
How often does the synchronisation between Arbor and Caterlytix happen?
The following synchronisation frequencies are configured in Caterlytix:
- Top-up payments from Arbor are pulled into Caterlytix every 10 minutes
- Any new student or staff meal accounts from Arbor are pulled into Caterlytix every hour
- Any sales transactions are sent from Caterlytix to Arbor every 5 minutes between 6am and 11pm
- At 6:30am Monday to Saturday, balance checks are performed between Arbor and Caterlytix to identify any possible discrepancies
Comments
Article is closed for comments.