Welcome to the onboarding guide for BuildMyStore. To enable seamless payment processing in your store, you will need to set up a merchant account with Cashfree Payments—one of India's leading payment aggregators.
This guide will walk you through creating your account, completing verification, and obtaining the secure credentials required to link your payments to our platform.
Estimated Time to Complete: 15–20 minutes (Account Setup)
Verification Timeline: 24 to 48 hours for KYC approval.
Prerequisites
Before you begin, please ensure you have the following documents and details ready. Having these on hand will prevent delays during the verification process.
Requirement |
Description |
Business PAN |
Permanent Account Number of the business or individual (for Sole Proprietors). |
Aadhaar Card |
For identity verification of the authorized signatory. |
GST Details |
Required if your business is GST registered. |
Bank Account Details |
Account number and IFSC code where you wish to receive settlements (payouts). |
Business Address Proof |
Utility bills, rental agreement, or GST certificate. |
Active Contact Info |
An email address and mobile number you have immediate access to. |
Step 1 — Create a Cashfree Account
The first step is to register your business on the Cashfree platform.
Visit the Cashfree Signup Page.
Enter your Work Email Address and choose a strong password.
Verify your email by clicking the link sent to your inbox.
Enter your Mobile Number and verify it using the OTP (One-Time Password) sent to you.
Step 2 — Complete Business Verification (KYC)
KYC (Know Your Customer) is a mandatory regulatory process to verify your business identity before you can accept real payments.
Select Business Type: Choose whether you are a Sole Proprietor, Private Limited, Partnership, or Individual.
Upload Documents: Follow the on-screen prompts to upload the documents listed in the Prerequisites section.
Bank Verification: Cashfree will perform a "Penny Drop" test—they will send ₹1 to your bank account to verify the details are correct.
Verification Status: Your account will remain in "Test Mode" until the Cashfree team reviews and approves your documents. This usually takes 24–48 working hours.
Step 3 — Access the Cashfree Merchant Dashboard
Once your account is created, you will land on the Merchant Dashboard. This is your command center for managing transactions, checking settlements, and finding your integration keys.
Navigation Path:
To find your credentials, use the main navigation menu on the left:
Click on Payment Gateway
Navigate to Developers in the sub-menu
Select API Keys
Step 4 — Generate Test API Credentials
Before going live, we recommend using Test Mode (also known as Sandbox Mode). This allows you to simulate payments without moving real money.
Ensure the toggle at the top of the dashboard is set to Test.
Go to Developers → API Keys.
Click Generate API Keys.
-
You will see two main values:
App ID (or Client ID): A public identifier for your account.
Secret Key: A private "password" for your integration.
What is an API Key? Think of an API Key as a digital handshake. It allows our platform to talk to Cashfree securely to confirm when a customer has paid you.
Step 5 — Generate Production/Live API Credentials
Once your KYC is approved (Status: Active), you can generate Live Credentials to start accepting real money from customers.
Switch the dashboard toggle from "Test" to Production (or "Live").
Navigate to Developers → API Keys.
Click Generate Production Keys.
Important: Download or copy your Secret Key immediately. For security reasons, Cashfree may mask or hide this key once you leave the page.
Credential Type |
Purpose |
Real Money? |
Test Credentials |
Used for setup and checking if the connection works. |
No |
Live Credentials |
Used for actual customer orders and sales. |
Yes |
Step 6 — Add Credentials to Our Platform
Now, you must provide these credentials to our system so we can process payments for you. Navigate to the Payment Settings section of our platform and fill in the fields as follows:
Our Platform Field |
Value from Cashfree Dashboard |
Cashfree App ID |
Copy the App ID (or Client ID) from your Cashfree dashboard. |
Cashfree Secret Key |
Copy the Secret Key generated in Step 5. |
Environment |
Select Live (or Production) to accept real payments. |
Security Best Practices
Your API credentials are the keys to your digital vault. Please handle them with extreme care:
Never share your Secret Key via email, WhatsApp, or chat support.
Avoid Public Access: Do not post screenshots of your full API keys on public forums or social media.
Authorized Personnel Only: Only provide keys to trusted administrators.
Rotation: If you suspect your Secret Key has been leaked, click Re-generate in the Cashfree dashboard immediately to invalidate the old one.
Common Issues & Troubleshooting
Problem |
Possible Cause |
Solution |
KYC Pending for 3+ days |
Document mismatch or missing info. |
Check your email for "Action Required" from Cashfree or contact their support. |
API Keys not visible |
You haven't clicked "Generate." |
You must manually click the "Generate" button in the Developer section. |
Invalid Credentials Error |
Mixing Test and Live keys. |
Ensure you aren't using a Test App ID with a Live Secret Key. |
Live Mode not clickable |
KYC is not yet approved. |
Wait for the "Account Activated" confirmation email from Cashfree. |
Final Verification Checklist
Before reaching out to our support team, please ensure you have completed the following:
Cashfree account created and email/mobile verified.
Business KYC documents uploaded and status shows "Active" or "Approved."
Successfully toggled the dashboard to Production/Live Mode.
Generated a Live Secret Key and copied it securely.
Input both the App ID and Secret Key into our platform settings.
Saved the settings on our platform.
Need Help? If you encounter issues within the Cashfree dashboard, you can visit the Cashfree Support Portal. For issues relating to our platform's settings, please contact our technical team.