Skip to content

Configuration

Everything both gateways need lives on one page: Admin → Plugins → Cashfree → Settings (admin login required). Configure it onceCashfree and Cashfree Subscription read the same credentials.

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

License

Paste your License KeySave Settings. A status badge shows the result:

BadgeMeaning
Active"License is active. Both Cashfree (direct payment) and Cashfree Subscription gateways are enabled."
Not configuredNo key entered yet
Invalid — payment gateway is disabled"License is not active. Cashfree gateways will not appear in Payment Gateway options until a valid license is entered and saved."

The check runs locally in the background against relyweb.co; brief outages are tolerated. If the badge slips, re-enter and re-save. See Licensing.

Service Configuration

The Cashfree credentials both gateways share, from Cashfree Dashboard → Developers → API Keys (Get your API keys).

FieldWhat to enter
App ID (x-client-id)Your client ID. Help: "From x-client-id in your Cashfree Dashboard → Developers → API Keys." Test keys begin with TEST
Secret Key (x-client-secret)Your secret (password field). Also the fallback for webhook signature verification when no Webhook Secret is set
Webhook Secret (endpoint-specific, optional)From Cashfree Dashboard → Developers → Webhooks → your endpoint → Secret Key (webhook version 2025-01-01 or newer). Blank verifies with your Secret Key
Sandbox modeTicked → test base URL https://sandbox.cashfree.com/pg; unticked → live production

Match keys to Sandbox mode

Cashfree selects environments via the checkbox, not the key format:

  • Sandbox ticked: Use Test keys (App ID starting with TEST).
  • Sandbox unticked: Use live Production keys.
  • Mismatch: Results in authentication failures at checkout.

Webhook Configuration

A reference card showing the values to paste into Cashfree. Your webhook endpoint:

https://YOUR_DOMAIN/cashier/cashfree/webhooks

Follow Configure webhooks to add the endpoint on both the Payment Gateway and Subscriptions tabs.

Save and next

Click Save Settings after any change. With an Active license, both gateways become available in Admin → Payment Gateways.

Documentation for the Relyweb app catalogue.