patch https://api.cashfree.com/pg/easy-split/vendors/
Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details such as name, email, phone number, upi details, and any of the KYC details.
For Auto Collect pass the Authorization token. Use the Authorize API to generate the token for Auto Collect APIs.
Vendor Instant Settlements
Use schedule option "8" or "9" to schedule instant settlements to your vendor account.
Schedule Options Supported
Schedule Options
| ID | Description |
|---|---|
| 1 | T+1 settlement at 11:00 AM |
| 2 | T+2 settlement at 11:00 AM |
| 3 | All transactions from 4:30 PM T-1 to 10:30 AM T+0 settled at 11AM T+0, and, 10:30 AM T+0 to 4:30PM T+0 at 5:00PM T+0 |
| 4 | All transactions from 2:00 PM T-1 to 2:00 PM T+0 settled at 3PM T+0 |
| 5 | All transactions till 5.30 at 6 |
| 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 |
List of Business Types
| Business Types |
|---|
| Government |
| Insurance |
| Jewellery |
| Gemstone/Diamond |
| Mutual funds/Broking |
| NBFCs / LSP / Organization into Lending |
| Non Profit / NGO |
| Online Gaming |
| Open/Partial Wallet (Bank & Non-bank PPI) |
| Pharmacy |
| Travel and Hospitality |
| Utilities |
| Aggregators (PAPG & Nodal Account) |
| Hemp Products / Herbal Products |
| FOREX |
| Chit Funds |
| Web host/Domain seller |
| Professional services (Doctors, Lawyers, Architects, CAs and other Professionals) |
| Food Industry |
| International Card Acceptance (Goods export) |
Response Codes
| Sub Code | Status | Message | Solution |
|---|---|---|---|
| 400 | ERROR | Invalid Name | Provide a valid name. The name should not have any special character except . / - &, |
| 400 | ERROR | Invalid vendorID | Specify an existing vendor ID. |
| 400 | ERROR | vendor_id_invalid | Specify an alphanumeric vendor ID. |
| 400 | ERROR | status_invalid | Specify a valid vendor status. Specify either ACTIVE or BLOCKED. |
| 400 | ERROR | Invalid customer name | Provide a valid name. Ensure the name size must be between 0 and 100. |
| 400 | ERROR | Email ID not specified | Specify a valid Email ID. |
| 400 | ERROR | Enter valid Email ID | Specify a valid Email ID. |
| 400 | ERROR | Phone number not specified | Specify a valid phone number. |
| 400 | ERROR | Please provide a valid Phone number | Specify a valid phone number without special characters and the length is 10 digits. |
| 400 | ERROR | Invalid account holder name | Specify the account number without any special characters except . / - &, |
| 400 | ERROR | Invalid account type. | Provide a valid account type without any special characters. Possible values: BUSINESS or INDIVIDUAL. |
| 400 | ERROR | Invalid PAN | Provide a valid PAN number without special characters and the length is 10 digits. |
| 400 | ERROR | Invalid uidai number | Provide a valid uidai (Aadhaar) number without special characters and the length is 12 digits. |
| 400 | ERROR | Invalid GST number | Provide a valid GST number without special characters and the length is 15 digits. |
| 400 | ERROR | Invalid cin | Provide a valid cin number without special characters and the length is 21 digits. |
| 400 | ERROR | Invalid passport number | Provide a valid passport number without any special characters and the length is 8 digits. |
| 400 | ERROR | 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 – Invalid IFSC code |
| John Doe | 026291800001190 | YESB0000262 | Failure – Invalid Account number |
| John Doe | 02014457596969 | CITI0000001 | Success (later to be 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 or updating the vendor details. 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 |