post https://api.cashfree.com/pg/easy-split/vendors
Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details such as account_type, business_type, gst, cin, pan, passport number and so on. Click here to read more on vendor KYC.
For Auto Collect pass the Authorization token. Use the Authorize API to generate the token for Auto Collect APIs.
Vendor Instant Settlements
PG - Use schedule option 8, 9, or 14 to schedule instant settlements to your vendor account.
AC - Use schedule option 8 or 9 to schedule instant settlements to your vendor account.
Schedule Options Supported
| ID | Description |
|---|---|
| 1 | T+1 settlement at 11:00 AM. |
| 2 | T+2 settlement at 11:00 AM. |
| 3 | All transactions from 4:45 PM T-1 to 10:45 AM T+0 settled at 11:15AM T+0, and, 10:45 AM T+0 to 4:45PM T+0 at 5:15PM T+0. |
| 4 | All transactions from 2:00 PM T-1 to 2:00 PM T+0 settled at 3:00 PM T+0. |
| 5 | All transactions till 5.30 PM at 6:00 PM. |
| 6 | Instant settlement every hour between 7:00 AM and 5:00 PM on working days. |
| 7 | Instant settlement every 3 hours between 8:00 AM and 5:00 PM on working days. |
| 8 | Instant settlement every hour 24*7. |
| 9 | Instant settlement every 3 hours 24*7. |
| 11 | Weekly every 1st working day. |
| 12 | Monthly every 1st working day. |
| 13 | T+1 settlement at 09:00 AM. |
| 14 | Instant settlement every 15 minutes 24*7. |
| 15 | T+3 settlement at 11:00 AM. |
| 16 | T+7 settlement at 11:00 AM. |
List of Business Types
| Business Types |
|---|
| B2B |
| Digital Goods |
| E-commerce |
| Education |
| Financial Services |
| Food and Beverages |
| Gaming |
| Government |
| Grocery |
| Health care |
| Insurance |
| Jewellery |
| NBFCs/Organizations 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) |
List of Account Types
| Account Types |
|---|
| Govt Authority/ULBs/Municipalities |
| Individual |
| LLP |
| Private Ltd or Public Ltd |
| Proprietorship |
| Society/Trust/Clubs/NGO/Association |
Response Codes
| Sub Code | Message | Solution |
|---|---|---|
| 400 | vendor_id_invalid | Specify a valid alphanumeric vendor ID. |
| 400 | status_invalid | Provide a valid status. Possible values are: ACTIVE or BLOCKED. |
| 400 | Invalid Name | Provide a valid name. The name should not have any special character except. / - &, |
| 400 | Invalid Name | Provide a valid name. Ensure the name size must be between 0 and 100. |
| 400 | Invalid email ID | Specify a valid Email ID. |
| 400 | Email ID not specified | Specify a valid Email ID. |
| 400 | Phone number not specified | Specify a valid phone number. |
| 400 | Please provide a valid Phone number | Specify a valid phone number without special characters and the length is 10 digits. |
| 400 | VPA not specified | Specify a valid VPA |
| 500 | Failed to validate VPA | Retry after sometime |
| 400 | Account holder name not specified | Specify a valid account holder name |
| 400 | Invalid account holder name | Specify an account number without any special characters except. / - &, |
| 400 | Invalid account type | Provide a valid account type without any special characters. Possible values: BUSINESS or INDIVIDUAL. |
| 400 | Invalid uidai number | Provide a valid uidai (Aadhaar) number without special characters and the length is 12 digits. |
| 400 | Invalid gst number | Provide a valid GST number without special characters and the length is 15 digits. |
| 400 | Invalid cin | Provide a valid CIN number without special characters and the length is 21 digits. |
| 400 | Invalid PAN | Provide a valid PAN number without special characters and the length is 10 digits. |
| 400 | Invalid passport number | Provide a valid passport number without any special characters and the length is 8 digits. |
| 400 | Merchant is not Active | Ensure merchant status is Active |
Sample bank account numbers and upi vpas to test the API in the test environment.
Bank Numbers
For banks, the primary parameters for transfer would be the bank account and IFSC number included while adding the vendor. Sample details shared below are to simulate different vendor settlement situations.
| Name | Account Number | IFSC | Remarks |
|---|---|---|---|
| John Doe | 026291800001191 | YESB0000262 | Success |
| John Doe | 00011020001772 | HDFC0000001 | Success |
| John Doe | 000890289871772 | SCBL0036078 | Success |
| John Doe | 000100289877623 | SBIN0008752 | Failed at bank |
| John Doe | 2640101002729 | CNRR0002640 | Failure – Invaid IFSC code |
| John Doe | 026291800001190 | YESB0000262 | Failure – Invalid Account number |
| John Doe | 02014457596969 | CITI0000001 | Success (later to Reversed) |
| Jon D | 026291800001191 | YESB0000262 | Failure - Account holder name matching failed |
UPI
For UPI, the primary parameter for transfer would be the UPI VPA included while adding the vendor. Use these UPI VPA to test transfers to the vendor account.
| VPA | Remarks |
|---|---|
| success@upi | Successful UPI transfer |
| incorrect@upi and invalid@upi | Failed UPI transfer |
Test Details
GSTIN Details
| GSTIN | Remarks |
|---|---|
| 29AAICP2912R1ZR | Valid |
| 27ABCFGH5678D1Z | Valid |
| 36JKLPQR9012E2Y | Valid |
| 45XYZLMN2345G3W | Valid |
| 12PQRST6789A4BC | Valid |
| 39ABCDE0987F6GH | Valid |
| 23UVWXYZ5678H5D | Valid |
| 05BBICP2912R1ZR | Valid |
| 29AAIZP2912R1ZR | Invalid |
| 05BBICA2912R1ZR | Invalid |
PAN Details
| PAN | Remarks |
|---|---|
| Individual PAN - ABCPV1234D | Valid |
| Individual PAN - XYZP4321W | Valid |
| Individual PAN - AZJPG7110R | Valid |
| Business PAN - ABCCD8000T | Valid |
| Business PAN - XYZH2000L | Valid |
| Business PAN - AAAHU4383C | Valid |
| Business PAN - AMJCL2021N | Valid |
| Individual PAN - DEFPV0126D | Invalid |
| Individual PAN - TUVP5678W | Invalid |
| Business PAN - LMNCD8010T | Invalid |
| Business PAN - EFGH2020L | Invalid |
Watch this video to learn how to add a new vendor via API