PaymentsApp ID (client ID) + Secret keyConfirm pricing before publishing
Cashfree Payments
Customers buy plans in India with UPI, cards, netbanking, wallets and pay-later through Cashfree's hosted checkout — once, or auto-renewing with Cashfree Subscriptions (UPI Autopay or card mandate).
AProvider definition
- Provider
- Cashfree Payments
- What it does
- Customers buy plans in India with UPI, cards, netbanking, wallets and pay-later through Cashfree's hosted checkout — once, or auto-renewing with Cashfree Subscriptions (UPI Autopay or card mandate).
- Why we need it
- Customers buy plans in India with UPI, cards, netbanking, wallets and pay-later through Cashfree's hosted checkout — once, or auto-renewing with Cashfree Subscriptions (UPI Autopay or card mandate).
- Used in
- Billing (Super Admin) · Plan checkout in Settings → Plan & billing · Refunds
BAccount requirements
- Account type
- Cashfree Payments merchant account (Payment Gateway product)
- Prerequisites
- Business KYC completed for production
- Website/app domain whitelisted for production
- Verification
- Production keys are issued after KYC and activation; sandbox keys work immediately.
CConnection method
- Authentication
- App ID (client ID) + Secret key
- Where to enter it
- Platform-wide (Super Admin): Super Admin → Platform → IntegrationsPlatform owner. Used for every customer who hasn't added their own key; can also be set as PLATFORM_KEY_<PROVIDER> on the API server.
Setup steps
- 1merchant.cashfree.com → Developers → API Keys: copy the App ID and Secret key (sandbox keys from the Test environment toggle, production keys after activation).
- 2Developers → Webhooks: add the webhook URL https://api.socialmati.com/api/webhooks/cashfree and subscribe to payment success, payment failed and user dropped events.
- 3For auto-renewal: enable the Subscriptions product, then in Subscriptions → Webhooks add the same URL and subscribe to subscription status changed, auth status, payment success, payment failed and payment cancelled.
- 4For production, whitelist your app domain (Developers → Whitelisting) so checkout opens from it.
- 5Super Admin → Platform → Integrations → Cashfree Payments: enter the App ID, Secret key and mode, save and click Test.
- 6Optional: Super Admin → Platform → Settings → Billing → set Default gateway to cashfree.
DPermissions & API scopes
No OAuth scopes — access is controlled by the key or token itself. Restrict keys to the APIs listed in the setup steps where the provider allows it.
This list is generated from the scopes the application's code requests.
EFree vs paid
- Free account / free API access
- No setup or monthly fee on standard plans.
- Card or billing account required?
- No.
- Paid plan / costs
- Per-transaction fees (MDR) by payment method; no monthly fee on standard plans.
- Quota and usage limits
- Provider-specific rate limits.
Not yet verified. Confirm on the provider's official pricing page before publishing.
FSetup screenshots
Capture each step with real values masked. Save images as public/docs/integrations/cashfree/1.png … 10.png and they appear here automatically.
- Screenshot to add1. Account login / creationThe provider's sign-in or sign-up page.
- Screenshot to add2. Developer consoleThe developer console or dashboard home.
- Not applicable3. Project / app creationCreating the app or project used for this integration.
- Not applicable4. API enablementThe API or product enabled for the project.
- Not applicable5. OAuth configurationConsent screen / OAuth settings with the redirect URIs.
- Screenshot to add6. API key / credentials creationCreating the key, secret or token (mask the value).
- Not applicable7. Permissions / scopesThe scopes or permissions requested or approved.
- Screenshot to add8. Billing / quota settingsBilling, credits or quota page.
- Screenshot to add9. Application connectionThe provider card in our application with fields filled (secrets masked).
- Screenshot to add10. Successful connectionThe green Test result or the connected account listed.
GApplication configuration
Never include real API keys, client secrets, access tokens or passwords in screenshots, tickets or documentation. Values below are field names and examples only.
| Field | Required | Example / default | Notes |
|---|---|---|---|
| App ID (client ID) | Yes | — | |
| Secret key | Yes | •••••••• | Stored encrypted; shown masked after saving. |
| Mode (sandbox / production) | Optional | — |
HTesting
- 1Click Test on the Cashfree card — “Keys accepted” confirms the App ID and Secret key.
- 2In sandbox mode, buy a plan from Settings → Plan & billing using Cashfree test UPI/card details; the plan activates and an invoice is created.
ITroubleshooting
| Problem | What to do |
|---|---|
| “Add your mobile number to pay with Cashfree” | Cashfree requires a customer phone; the customer enters it once at checkout and it's saved to their profile. |
| Checkout opens but the plan isn't activated | Check the webhook URL in Cashfree and that the API is reachable over HTTPS; the return page also re-checks the order. |
| Domain not whitelisted | Whitelist the app domain in Cashfree before using production keys. |
| Invalid credentials | The key or token is wrong, revoked or from another project. Create a new one and paste it again, then click Test. |
| Missing permissions | The key's project or role doesn't include this API. Grant access or create the key in the right project. |
| API not enabled | Enable the API/product for the project or app in the provider console and wait a few minutes. |
| Quota exceeded | Wait for the quota window to reset (see section E) or request a higher quota / add credits. |
| Account not eligible | Check the account requirements in section B (e.g. business/professional account, verified property, registered organisation). |
| Billing required | Add a payment method or prepaid credits on the provider account (see section E). |
JDisconnect & security
- Revoke access at the provider
- Regenerate the Secret key in Cashfree Developers → API Keys, then update it in Platform → Integrations.
- Disconnect in the application
- Super Admin → Platform → Integrations → open the card → Remove / Disconnect. Connected accounts can be disconnected per brand.
- Rotate credentials
- Create the new key or secret first, paste it into the same card and Test, then delete the old one at the provider — no downtime.
- How credentials are stored
- Encrypted at rest with AES-256-GCM using the server's ENCRYPTION_KEY, shown masked after saving, never returned to the browser, and used only from the API server.
- What data the application can access
- Orders and payments created by the platform for plan purchases.

