Skip to content

Configuration

Everything the Cashfree gateways need lives on one page: Admin → Plugins → Cashfree → Settings (you must be logged in as an admin). You configure it once — both the Cashfree and Cashfree Subscription gateways read the same credentials, so there is no per-gateway setup. This page walks you through each of the three cards on that screen and what to enter.

The Cashfree settings page with its three cardsAdmin → Plugins → Cashfree → Settings

License

The first card is where you paste your license key and confirm it is valid.

Enter your License Key and click Save Settings. A status badge shows the result:

  • Active — you're good. The card confirms: "License is active. Both Cashfree (direct payment) and Cashfree Subscription gateways are enabled."
  • Not configured — you haven't entered a key yet.
  • Invalid — payment gateway is disabled — the key isn't valid, so the gateways stay hidden. The card explains: "License is not active. Cashfree gateways will not appear in Payment Gateway options until a valid license is entered and saved."

The license check runs locally in the background against relyweb.co; brief outages are tolerated. If the badge ever slips, re-enter and re-save your key to restore it. See Licensing for the full picture.

Service Configuration

This card holds the Cashfree credentials that both gateways share. You get all of these from Cashfree Dashboard → Developers → API Keys — see Get your API keys.

  • App ID (x-client-id) — your Cashfree client ID. The field help reads "From x-client-id in your Cashfree Dashboard → Developers → API Keys." Test keys begin with TEST.
  • Secret Key (x-client-secret) — your Cashfree secret, entered as a password. It is also used as a fallback for webhook signature verification when you haven't set an endpoint-specific Webhook Secret.
  • Webhook Secret (endpoint-specific, optional) — from Cashfree Dashboard → Developers → Webhooks → your endpoint → Secret Key (webhook version 2025-01-01 or newer). Leave it blank to verify webhooks with your Secret Key instead.
  • Sandbox mode — use the Cashfree test environment — a checkbox that decides which Cashfree environment the plugin talks to. Ticked, it uses the test base URL https://sandbox.cashfree.com/pg; unticked, it uses live production.

The checkbox chooses the environment — not the key format

Cashfree does not switch environments based on your key format. You must match them yourself: use Test keys (App ID begins TEST) with Sandbox ticked, and Production keys with Sandbox unticked. Mismatching them causes an authentication failure at checkout.

Webhook Configuration

The third card is a reference panel. It shows the exact endpoint URL to paste into Cashfree, the webhook version, the events to enable and the Cashfree IPs to whitelist — so you can copy them straight into your dashboard. Your webhook endpoint is:

https://YOUR_DOMAIN/cashier/cashfree/webhooks

Setting up webhooks correctly is what lets Cashfree confirm payments and subscription events back to AcelleMail. Follow Configure webhooks to add the endpoint on both the Payment Gateway and Subscriptions tabs.

Save and next steps

Whenever you change anything on this page, click Save Settings. After a successful save with an Active license, both gateways are available in Admin → Payment Gateways. From here:

Documentation for the Relyweb app catalogue.