Cashfree Integration Configuration Guide

Overview

The Cashfree integration enables your CRM to manage payments, subscriptions, Aadhaar-based eSign workflows, and beneficiary payouts through a single configuration.

The integration supports the following modules:

Payment Gateway

• Collect customer payments
• Generate payment links
• Manage subscriptions
• Track payment status
• Receive webhook notifications
• Support Easy Split settlements by automatically distributing funds to vendors

Secure ID (Aadhaar eSign)

• Aadhaar-based document signing
• MITC signing workflows
• Digital document verification
• eSign status tracking

Payouts

• Transfer funds to beneficiaries
• Vendor payouts
• Customer disbursements
• Payout status tracking

Prerequisites

Before starting the configuration, ensure:

• You have an active Cashfree account.
• The required Cashfree products are activated in Production mode:
• Payment Gateway
• Subscriptions
• Easy Split
• Secure ID
• Payouts
• If a product is not enabled, contact Cashfree Support or submit the activation request from the Cashfree Dashboard.
• You have access to cashfree app in cs.fabbuilder.com.

Select the Environment

Cashfree maintains separate configurations for Test and Production environments.

1. Login to Cashfree.
2. Select the required environment from the header:

• Test
• Production

1. Open the Developers section.

Note: Test and Production environments use different credentials. Complete all configuration steps in the environment you intend to use.

Configure Payment Gateway

The Payment Gateway setup also covers Payment Links, Subscriptions, and Easy Split.

Step 1: Get API Credentials

Navigate to:

Developers → Payment Gateway → API Keys

Copy:

• App ID
• Secret Key

Step 2: Configure CRM

Navigate to:

Workspace → App & Integration → App

1. Search for Cashfree.
2. Click Configure.
3. Select the active environment.
4. Enter:

• App ID
• Secret Key

1. Save the configuration.

Step 3: Configure Payment Gateway Webhook

The Cashfree configuration dialog displays a tenant-specific webhook URL.

Copy the webhook URL and navigate to:

Developers → Payment Gateway → Webhooks → Payment Gateway

Add the webhook URL and enable:

• Vendor Status Update

This event is required for Easy Split vendor onboarding and status tracking.

Step 4: Configure Payment Link Webhook

Navigate to:

Developers → Payment Gateway → Webhooks → Payment Links

Add the same webhook URL copied from the CRM configuration screen.

No event selection is required.

Step 5: Configure Subscription Webhooks

Navigate to:

Developers → Subscriptions → Webhooks → Subscriptions

Add the same webhook URL and enable:

• Subscription Auth Status
• Subscription Payment Success
• Subscription Payment Failed
• Subscription Status Changed

These events are required for recurring payment and subscription lifecycle management.

Step 6: Configure Whitelisting (Production Only)

Navigate to:

Developers → Payment Gateway → Whitelisting

Whitelisting is not required in the Test environment.

If your Production account requires whitelisting, complete the setup before going live.

Reference:

https://www.cashfree.com/docs/payments/online/go-live/whitelist

Configure Secure ID (Aadhaar eSign)

Secure ID is used for Aadhaar-based document signing and MITC workflows.

Step 1: Get Secure ID Credentials

Navigate to:

Developers → Secure ID → API Keys

Copy:

• Secure ID
• Secure ID Secret

Step 2: Configure CRM

Enter the following values in the Cashfree configuration screen:

• Secure ID
• Secure ID Secret

Save the configuration.

Step 3: Configure Secure ID Webhook

Navigate to:

Developers → Secure ID → Webhooks

Copy the Secure ID webhook URL from the CRM configuration screen and add it in Cashfree.

Save the configuration.

Step 4: Configure Two-Factor Authentication

Navigate to:

Developers → Secure ID → Two-Factor Authentication

Copy the IP address displayed in the App configuration dialog and add it to the whitelist.

This step is required for Secure ID requests originating from the CRM.

Configure Payouts

Payouts enable fund transfers to beneficiaries and vendors.

Step 1: Get Payout Credentials

Navigate to:

Developers → Payouts → API Keys

Copy:

• Payout ID
• Payout ID Secret

Step 2: Configure CRM

Enter the following values in the Cashfree configuration screen:

• Payout ID
• Payout ID Secret

Save the configuration.

Step 3: Configure Payout Webhook

Navigate to:

Developers → Payouts → Webhooks

Copy the payout webhook URL from the CRM configuration screen and add it in Cashfree.

Save the configuration.

Step 4: Configure Two-Factor Authentication

Navigate to:

Developers → Payouts → Two-Factor Authentication

Copy the IP address displayed in the CRM configuration screen and add it to the whitelist.

This step is required to allow payout requests from the CRM.

Verification

After completing the configuration, verify each module.

Payment Gateway

• Create a test payment
• Verify payment status updates
• Verify webhook delivery

Payment Links

• Generate a payment link
• Complete payment
• Verify status updates

Subscriptions

• Create a subscription
• Verify subscription events
• Verify recurring payment updates

Secure ID

• Initiate a test eSign request
• Complete Aadhaar verification
• Verify signed document updates

Payouts

• Initiate a test payout
• Verify payout status updates
• Verify webhook delivery