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
headerrequired

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

ā€‹
x-client-secret
string
headerrequired

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

Headers

ā€‹
x-api-version
string
default: 2023-08-01required

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

ā€‹
vendor_id
string
required

Specify the unique Vendor ID to identify the beneficiary. Alphanumeric and underscore (_) allowed.

ā€‹
status
string
required

Specify the status of vendor that should be updated. Possible values: ACTIVE,BLOCKED, DELETED

ā€‹
name
string
required

Specify the name of the vendor to be updated. Name should not have any special character except . / - &

ā€‹
email
string
required

Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com) should contain @ and dot (.)

ā€‹
phone
string
required

Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits, 8 - 12 characters after excluding +91).

ā€‹
kyc_details
object[]
required

Specify the kyc details that should be updated.

ā€‹
verify_account
boolean

Specify if the vendor bank account details should be verified. Possible values: true or false

ā€‹
dashboard_access
boolean

Update if the vendor will have dashboard access or not. Possible values are: true or false

ā€‹
schedule_option
number

Specify the settlement cycle to be updated. View the settlement cycle details from the "Settlement Cycles Supported" table. If no schedule option is configured, the settlement cycle ID "1" will be in effect. Select "8" or "9" if you want to schedule instant vendor settlements.

ā€‹
bank
object[]

Specify the vendor bank account details to be updated.

ā€‹
upi
object[]

Updated beneficiary upi vpa. Alphanumeric, dot (.), hyphen (-), at sign (@), and underscore allowed (100 character limit). Note: underscore and dot (.) gets accepted before and after @, but hyphen (-) is only accepted before @ sign.

Response

200 - application/json

Create Vendor Response

ā€‹
email
string
ā€‹
status
string
ā€‹
bank
object[]
ā€‹
upi
string
ā€‹
phone
number
ā€‹
name
string
ā€‹
vendor_id
string
ā€‹
schedule_option
object[]
ā€‹
kyc_details
object[]
ā€‹
dashboard_access
boolean
ā€‹
bank_details
string

Was this page helpful?

OverviewGet Vendor All Details