Connect Cashfree

Use this guide to connect the school's own Cashfree Payment Gateway account to the School ERP. The card is called Cashfree Payment Gateway. It needs two values: App ID / Client ID and Secret key / Client secret. Cashfree has a test (sandbox) environment and a production environment, each with its own keys.

Before you start#

• The school has a Cashfree Payment Gateway merchant account. For live payments, Cashfree must have activated it.
• You have the school administrator's login for the School ERP.
• Read Set up a gateway in Payment Configuration once.

Cashfree's screens change from time to time. If a menu below looks different, follow Cashfree's own documentation for Payment Gateway API keys, domain whitelisting and webhooks.

Get your keys from Cashfree#

1. Sign in to the Cashfree merchant dashboard and open the Payment Gateway product.
2. Switch to the test (sandbox) environment.
3. Open the developer section and the API keys page. Generate or view the keys.
4. Copy the App ID (also called Client ID) and the Secret key (also called Client secret).

Enter them in the School ERP#

1. Open General Settings › Payment Configuration.
2. Set Environment to Test / sandbox, then select Configure on the Cashfree Payment Gateway card.
3. Check that Test environment is selected.
4. Paste into App ID / Client ID and Secret key / Client secret.
5. Select Save settings.

Cashfree has no Test connection button in the ERP. You prove the keys with a sandbox payment instead.

Approve your ERP's web address in Cashfree#

Cashfree only opens its checkout for web addresses the merchant has approved (whitelisted).

1. In the Cashfree dashboard, open the domain whitelisting page in the developer section.
2. Add the web address you use to open your School ERP. Cashfree may ask for proof that the website is yours.
3. Wait for Cashfree to approve it. Production needs this before parents can pay.

Register the webhook in Cashfree#

1. In the ERP, select Copy Webhook URL below the form.
2. In the Cashfree dashboard, open the webhooks page in the developer section and add a new endpoint.
3. Paste the address and select the payment and refund events.
4. Save it. No separate webhook secret is needed for Cashfree; the keys you already saved are enough.

Test, then go live#

1. Select Start sandbox payment and complete a test payment. See Test a payment end to end.
2. Switch the Cashfree dashboard to production and copy the production App ID and Secret key.
3. In the ERP panel select Live environment, paste the production keys, tick Enable and use this gateway for fee payments and select Save settings.
4. Copy the live Webhook URL and register it in Cashfree's production webhooks.
5. Make sure your ERP's web address is whitelisted in production.

Good to know#

• The ERP confirms every payment with Cashfree before posting a receipt. The webhook makes confirmation quicker.
• Cashfree settlements are not fetched into the ERP. Record each bank settlement by hand. See Reconciliation and settlements.
• Refund from the ERP, not from the Cashfree dashboard. See Refund an online payment.

Troubleshooting#