Connect PayGlocal
Get the merchant ID and the two key pairs from the Glocal Command Center and connect PayGlocal PayCollect in Payment Configuration.
Use this guide to connect the school's own PayGlocal merchant account to the School ERP. The card is called PayGlocal, and it uses PayGlocal's PayCollect hosted checkout. It needs five values: Merchant ID (MID), PayGlocal public key ID, PayGlocal public key (PEM), Your private key ID and Your private key (PEM). PayGlocal's UAT (test) and production environments have different merchant IDs and keys; values from one never work in the other.
Before you start#
- The school has an approved PayGlocal merchant account with PayCollect switched on.
- You can sign in to the Glocal Command Center.
- You have the school administrator's login for the School ERP.
- Student records carry a name in letters and spaces, and an e-mail address. PayGlocal needs both for every payer.
- Read Set up a gateway in Payment Configuration once.
PayGlocal's screens change from time to time. If a menu below looks different, follow PayGlocal's own merchant documentation.
Get the values from the Glocal Command Center#
Do these steps in the UAT environment first.
- Note the Merchant ID (MID). It is under your account's TID details, in the payment gateway section.
- Open Key Management and download PayGlocal's public key file for this environment.
- Note the PayGlocal public key ID: it is the part of that file's name before the first underscore.
- Still in Key Management, generate your own key pair. Note your key ID from the Key Management table; the private key file's name also starts with it.
- Download your private key straight away. PayGlocal lets you download it only at that moment and does not keep a copy. Store it where only the people who set up payments can reach it.
Enter them in the School ERP#
- Open General Settings › Payment Configuration.
- Set Environment to Test / sandbox, then select Configure on the PayGlocal card.
- Check that Test environment is selected.
- Type the Merchant ID (MID) and the PayGlocal public key ID.
- Open PayGlocal's public key file in a plain text editor (such as Notepad), copy everything including the first and last lines, and paste it into PayGlocal public key (PEM).
- Type Your private key ID.
- Open your private key file the same way, copy all of it including the first and last lines, and paste it into Your private key (PEM).
- Select Save settings. The private key is never shown again on the screen.
The ERP sends PayGlocal the address to return the parent to with every payment, and it confirms each payment by checking its status with PayGlocal. The screen shows a Webhook URL, but the ERP does not use PayGlocal's server notifications, so you do not need to register it with PayGlocal.
PayGlocal has no Test connection button in the ERP. You prove the keys with a sandbox payment instead.
Test, then go live#
- Select Start sandbox payment and complete a test payment. See Test a payment end to end.
- In the production Glocal Command Center, collect the production merchant ID, download PayGlocal's production public key, and generate and download a production key pair of your own.
- In the ERP panel select Live environment, fill in the five production values the same way, tick Enable and use this gateway for fee payments and select Save settings.
Good to know#
- A single PayGlocal payment can be from ₹1 to ₹10,00,000.
- Refunds can be started from the ERP. PayGlocal processes them in the background, and the ERP shows the refund as complete only when PayGlocal reports it settled. See Refund an online payment.
- PayGlocal settlements are not fetched into the ERP. Record each bank settlement by hand. See Reconciliation and settlements.
- If your private key is lost, generate a new key pair in Key Management and save the new private key and key ID in the ERP.
Troubleshooting#
| What you see | What to do |
|---|---|
| PayGlocal needs the payer name in letters and spaces, 2 to 100 characters. | The student's name has a character PayGlocal does not accept, such as a full stop or a digit. If the school offers another gateway, the family can choose it under Pay with. |
| The sandbox payment fails at the start | Check that all five values are from UAT, and that each key was pasted whole, with its first and last lines. |
| A key was pasted into the wrong box | Paste each key again into the right box and save. Blank boxes keep the saved value, so fill in every box you want to change. |
