Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Before you add a vendor, review the required documents that are applicable to different vendor types and business categories. They are mentioned in the tables below. To add a new vendor, follow the Dashboard or API instructions below.
Use the Merchant Dashboard to add a single vendor via the Easy Split interface.To add a new vendor:
  1. Log in to the Merchant Dashboard.
  2. Go to Payment Gateway > Easy Split - Vendor > Add Vendor.
  3. Enter the following details and select Next:
    • Vendor ID: ID of the vendor.
    • Phone number
    • Email ID
    • Vendor line of business: For available options, see Vendor LOB.
    • Vendor business type: Choose Individual or Business Entity.
    • Settlement cycle: Select a schedule option. For available options, see Available schedule options.
  4. Add vendor bank account details (account holder name, account number, and IFSC) or UPI VPA.
You can provide either the vendor bank account details or a UPI VPA. Do not provide both.
  1. Enable Dashboard Access to allow the vendor to access the Vendor Dashboard. For more information, see Vendor Dashboard overview. This step is optional.
  2. Select Verify Account Details to validate the beneficiary bank account or UPI VPA.
Verifying bank accounts and UPI VPA is chargeable. Make sure you have sufficient balance before proceeding, or continue without verification.
  1. Provide KYC documents according to vendor type (Individual or Business Entity). For required documents and limits, see the KYC document requirement section.
  2. Select Add Vendor Details to complete onboarding. The new vendor appears in Easy Split - Vendor.

Add multiple vendors (batch upload)

Prepare a batch file using the sample CSV template. Ensure all required columns are present and formatted correctly.To add multiple vendors:
  1. Log in to the Merchant Dashboard.
  2. Go to Payment Gateway > Easy Split - Vendor.
  3. Select Upload File and choose the prepared batch file.
  4. Select Upload to start processing. The system validates the file and processes valid rows.
  5. After processing completes, download the error log (if any) and fix rows that failed validation.
  6. Reupload the corrected file to add the remaining vendors.
  • File size limit: 8 MB. Maximum records per upload: 50.
  • The upload fails if the file does not match the required format. Always download and review the error log, fix issues, and reupload only the failed rows.
Watch this video to learn how to add vendors via the Merchant Dashboard.

Available schedule options

Use schedule option 8, 9, 14, or 17 to schedule instant settlements to your vendor account.
IDDescription
1T+1* settlement at 11:00 AM.
2T+2* settlement at 11:00 AM.
3All transactions from 4:45 PM T-1 to 10:45 AM T+0* settled at 11:15 AM T+0*, and, 10:45 AM T+0* to 4:45 PM T+0* at 5:15 PM T+0*.
4All transactions from 2:00 PM T-1 to 2:00 PM T+0 settled at 3:00 PM T+0*.
5All transactions till 5:30 PM at 6:00 PM.
6Instant settlement every hour between 7:00 AM and 5:00 PM on working days.
7Instant settlement every 3 hours between 8:00 AM and 5:00 PM on working days.
8Instant settlement every hour 24*7.
9Instant settlement every 3 hours 24*7.
11Weekly every 1st working day.
12Monthly every 1st working day.
13T+1* settlement at 09:00 AM.
14Instant settlement every 15 minutes 24*7.
15T+3* settlement at 11:00 AM.
16T+7* settlement at 11:00 AM.
17Instant settlement every minute 24*7.
T+x*: Settlement cycle is subject to bank approval and can vary based on transaction type, business category/model, risk parameters, and other factors.

Vendor status workflow

When you onboard a vendor from the dashboard or use the APIs, the vendor goes through various states. The following table describes the vendor statuses during the onboarding process.
Vendor statusDescription
IN_BANK_VALIDATIONThe bank account validation process has been initiated.
BANK_VALIDATION_FAILEDThe bank validation has failed. Update the bank account details to the correct ones.
IN_BENE_CREATIONThe vendor creation process has been initiated.
BENE_CREATION_FAILEDThe beneficiary creation at the partner bank has failed. Update the bank account details to retry beneficiary creation.
IN_KYC_REVIEWThe vendor is created and not all mandatory KYC documents are successfully verified. Ensure all mandatory documents are submitted.
ACTION_REQUIREDOne or more KYC documents have failed verification. The merchant must submit correct, updated, or relevant KYC documents to continue with vendor onboarding.
ACTIVEThe vendor KYC documents are verified successfully and the vendor is active.
ON_HOLDThe Cashfree Payments onboarding team has placed the account on hold because the documents are unavailable or insufficient.
BLOCKEDThe vendor is blocked.
DELETEDThe vendor is deleted.
The image below shows the vendor onboarding flow.

Document status workflow

The following table describes the states a document goes through during the verification process.
Document statusDescription
Due CurrentlyDocuments in this state are pending mandatory documents that must be submitted to onboard a vendor.
Due EventuallyThese are additional documents that must be submitted based on different limits. If a vendor is going to breach certain limits in the future, submit these documents along with the documents in the Due Currently category. This ensures that the vendor state is not affected by limit breaches. Example: GST is mandatory if the sum of vendor settlements to a single PAN or merchant across vendors exceeds 20 lakhs in the last twelve months.
In ReviewThe KYC documents are submitted and under review. Once verification is complete, the document status changes to Verified or Action Required.
VerifiedThe KYC document submitted is verified successfully.
Action RequiredThe KYC document verification has failed. Upload a correct or fresh document to continue.
The image below shows the document status workflow.

KYC document requirement

The following table lists the required documents based on applicable limits. Requirements vary by merchant type and vendor type.
Document requirementLimitAlternatives
PANRequired for all limitsGSTIN
GSTIN> 20 LakhsNA

List of vendor line of business (LOB)

The following list contains all supported vendor lines of business (LOB).
Vendor LOB
B2B
Digital Goods
E-commerce
Education
Financial Services
Food and Beverages
Gaming
Government
Grocery
Health care
Insurance
Jewellery
NBFCs/Organisations into Lending
Logistics
Miscellaneous
Mutual funds/Broking
Non Profit/NGO
Online Gaming
Open and Semi Open Wallet
Pan shop
Pharmacy
Readymade
Real Estate, Housing, Rentals
Retail and Shopping
SaaS
Social Media and Entertainment
Society/Trust/Club/Association
Telecom
Travel and Hospitality
Utilities
Chit Funds
Web host/Domain seller
Professional Services (Doctors, Lawyers, Architects, CAs, and other Professionals)

Vendor LOB specific documents

If the vendor type is NBFC, the following additional documents are required:
  • CIN
  • NBFC and LSP Agreement
  • NBFC Certificate
  • NBFC domain confirmation email on Cashfree partnership