API Documentation
Create Account📁 Change LogsContact Sales

Create Vendor

post https://api.cashfree.com/api/v2/api/v2/easy-split/vendors

Use this API to create a new vendor to your EasySplit account. You can settle funds only after you have added vendors to your account. Provide vendor details such as vendor ID, phone number, email ID, account number, IFSC code and so on.

Settlement Cycles Supported

Settlement Cycle Details

IDDescription
1T+1 settlement at 11:00 AM
2T+2 settlement at 11:00 AM
3All 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
4All transactions from 2:00 PM T-1 to 2:00 PM T+0 settled at 3PM T+0
5All transactions till 5.30 at 6
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
Response Codes
Sub CodeStatusMessageSolution
200SUCCESSVendor is added successfully
400ERROREmail ID not specifiedSpecify a valid Email ID
400ERROREnter valid Email IDSpecify a valid Email ID
400ERRORPlease provide a valid statusSpecify a valid vendor status
400ERRORAccount number not specifiedSpecify a valid account number
400ERRORBank account number should contain 9 to 30 alphanumeric charactersEnsure the account number contains 9 to 30 alphanumeric characters
400ERRORIFSC not specifiedSpecify a valid IFSC code
400ERROREnter valid IFSCSpecify a valid IFSC code
400ERRORVPA not specifiedSpecify a valid VPA
400ERRORAccount holder name not specifiedSpecify a valid account holder name
400ERRORInvalid account holder name. Account holder name should include alphabets onlyEnsure the account holder name contains only alphabets
400ERRORPhone number not specifiedSpecify a valid phone number
400ERRORPlease provide a valid Phone numberSpecify a valid phone number
400ERRORPlease provide a valid nameSpecify a valid vendor name
400ERRORInvalid Name. Name should include alphabets onlySpecify a valid vendor name
400ERRORPlease provide a valid idSpecify a valid vendor ID
400ERRORVendorId not specifiedSpecify a valid vendor ID
400ERRORIncorrect settlement cycle ID. Enter valid IDSpecify a valid settlement cycle ID
400ERRORBank or UPI, only one can be passed and not bothUse either Bank or UPI mode
400ERRORVendor account number or UPI address is requiredProvide the vendor account number or the UPI address
400ERRORMerchant is not ActiveEnsure merchant status is Active
400ERROREnter valid UPI VPASpecify a valid UPI VPA
400ERRORIncorrect settlement cycle ID. Enter valid IDSpecify a valid settlement cycle ID
500ERRORFailed to validate VPARetry after sometime
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.

NameAccount NumberIFSCRemarks
John Doe026291800001191YESB0000262Success
John Doe00011020001772HDFC0000001Success
John Doe000890289871772SCBL0036078Success
John Doe000100289877623SBIN0008752Failed at bank
John Doe2640101002729CNRR0002640Failure – Invaid IFSC code
John Doe026291800001190YESB0000262Failure – Invalid Account number
John Doe02014457596969CITI0000001Success (later to Reversed)
Jon D026291800001191YESB0000262Failure - 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.

VPARemarks
success@upiSuccessful UPI transfer
incorrect@upi and invalid@upiFailed UPI transfer

Watch this video to learn how to add a new vendor via API

Language