Connect Razorpay

Use this guide to connect the school's own Razorpay merchant account to the School ERP. Razorpay needs three values in the ERP: Key ID, Key secret and Webhook secret. Razorpay's dashboard has separate test and live modes, and each mode has its own keys.

Before you start#

• The school has a Razorpay merchant account. For live payments, Razorpay must have activated it.
• You have the school administrator's login for the School ERP.
• You can sign in to the Razorpay dashboard as the account owner, or as a user with rights to manage API keys and webhooks.
• Read Set up a gateway in Payment Configuration once.

Razorpay's screens change from time to time. If a menu below looks different, follow Razorpay's own documentation for API keys and webhooks.

Get your keys from Razorpay#

1. Sign in to the Razorpay dashboard.
2. Switch the dashboard to test mode. Start with test keys.
3. Open the API keys page in the dashboard's account settings and generate a key.
4. Copy the Key ID and the Key secret. Razorpay shows the secret only when the key is generated, so keep it safely until you have pasted it into the ERP.
5. Decide a webhook secret: a long random phrase that you make up. You will type the same phrase in Razorpay and in the ERP. It must be different from the Key secret.
6. In the payment capture settings, make sure payments are captured automatically. A payment that Razorpay has only authorised, and not captured, is not recorded as paid in the ERP.

Enter them in the School ERP#

1. Open General Settings › Payment Configuration.
2. Set Environment to Test / sandbox, then select Configure on the Razorpay card.
3. Check that Test environment is selected.
4. Paste into Key ID, Key secret and Webhook secret.
5. Select Save settings.
6. Select Test connection. A success message means Razorpay accepted the keys. It does not prove a payment will go through.

Register the webhook in Razorpay#

1. In the ERP, select Copy Webhook URL below the form.
2. In the Razorpay dashboard (still in test mode), open the webhooks page in settings and add a new webhook.
3. Paste the address into the webhook URL box.
4. Type the same webhook secret you entered in the ERP.
5. Select the payment and refund events. Razorpay's documentation lists them.
6. Save the webhook in Razorpay.

Razorpay's checkout returns the parent to the ERP on its own. The ERP also shows a Return URL; if Razorpay ever asks for a return or redirect address, use Copy Return URL and paste that.

Test, then go live#

1. Run a test payment. See Test a payment end to end.
2. When it works, switch the Razorpay dashboard to live mode and generate live keys.
3. In the ERP panel select Live environment, paste the live Key ID and Key secret, and a new webhook secret for live.
4. Tick Enable and use this gateway for fee payments, choose the other options, and select Save settings.
5. Copy the live Webhook URL and add it as a webhook in Razorpay's live mode, with the live webhook secret.
6. Select Test connection again for the live keys.

Good to know#

• Test keys and live keys never work in the other mode. If Test connection fails, check the mode first.
• The ERP confirms every payment with Razorpay before posting a receipt. The webhook makes confirmation quicker; the ERP still checks without it.
• Razorpay settlements are not fetched into the ERP. Record each bank settlement by hand. See Reconciliation and settlements.
• Refund from the ERP, not from the Razorpay dashboard. See Refund an online payment.

Troubleshooting#