POST
/
easy-split
/
vendors
curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/vendors \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "vendor_id": "vendortest123",
  "status": "ACTIVE",
  "name": "customer",
  "email": "johndoe@cashfree.com",
  "phone": 9876543210,
  "verify_account": true,
  "dashboard_access": true,
  "schedule_option": 1,
  "bank": {
    "account_number": 12345678890,
    "account_holder": "John Doe",
    "ifsc": "HDFC019345"
  },
  "kyc_details": {
    "account_type": "BUSINESS",
    "business_type": "NBFC",
    "uidai": 753624181019,
    "gst": "11AAAAA1111A1Z0",
    "cin": "L00000Aa0000AaA000000",
    "pan": "BIAPA2934N",
    "passport_number": "L6892603"
  }
}'
{
  "email": "johndoe@cashfree.com",
  "status": "IN_BENE_CREATION",
  "bank": {
    "account_number": 26291800001191,
    "account_holder": "JOHN DOE",
    "ifsc": "YESB0000262"
  },
  "upi": null,
  "phone": 9876543210,
  "name": "customer",
  "vendor_id": "TestAccount11",
  "schedule_option": {
    "settlement_schedule_message": "T+1 settlement at 11:00 AM",
    "schedule_id": 1,
    "merchant_default": false
  },
  "kyc_details": {
    "account_type": "BUSINESS",
    "business_type": "NBFC",
    "pan": "AFDHK1234F",
    "uidai": null,
    "passport_number": null,
    "driving_license": null,
    "voter_id": null,
    "gst": "11AAAAA1111A1Z0",
    "cin": "L00000Aa0000AaA000000"
  },
  "dashboard_access": false,
  "bank_details": null
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2023-08-01
required

API version to be used. Format is in YYYY-MM-DD

​
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

​
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json

Create Vendor Request Body.

Create Vendor Request

Response

200
application/json

Create Vendor Success Response.

Create Vendor Response