GET
/
easy-split
/
vendors
/
{vendor_id}
{
  "email": "johndoe@cashfree.com",
  "status": "IN_BENE_CREATION",
  "phone": 9876543210,
  "name": "customer",
  "vendor_id": "johntest11111",
  "added_on": "2023-03-02 12:12:56",
  "updated_on": "2023-03-02 12:12:57",
  "bank": {
    "account_number": 123456111110,
    "account_holder": "JOHNDOE",
    "ifsc": "YESB0000262"
  },
  "upi": null,
  "schedule_option": {
    "settlement_schedule_message": "T+1 settlement at 11:00 AM",
    "schedule_id": 1,
    "merchant_default": true
  },
  "vendor_type": "PG",
  "account_type": "BUSINESS",
  "business_type": "NBFC",
  "related_docs": [
    {
      "vendor_id": "johntest11111",
      "doc_type": "CIN_NUMBER",
      "doc_value": "L00000Aa0000AaA000000",
      "status": "IN_REVIEW",
      "remarks": null
    },
    {
      "vendor_id": "johntest11111",
      "doc_type": "GSTIN_NUMBER",
      "doc_value": "11AAAAA1111A1Z0",
      "status": "IN_REVIEW",
      "remarks": null
    },
    {
      "vendor_id": "johntest11111",
      "doc_type": "PAN_NUMBER",
      "doc_value": "BIAPA2934N",
      "status": "IN_REVIEW",
      "remarks": null
    },
    {
      "vendor_id": "johntest11111",
      "doc_type": "PASSPORT_NUMBER",
      "doc_value": "L6892603",
      "status": "IN_REVIEW",
      "remarks": null
    },
    {
      "vendor_id": "johntest11111",
      "doc_type": "UIDAI_NUMBER",
      "doc_value": 753624181019,
      "status": "IN_REVIEW",
      "remarks": 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.

Path Parameters

ā€‹
vendor_id
string
required

The id which uniquely identifies your vendor.

Response

200 - application/json

Vendor entity object

ā€‹
email
string
ā€‹
status
string
ā€‹
phone
string
ā€‹
name
string
ā€‹
vendor_id
string
ā€‹
added_on
string
ā€‹
updated_on
string
ā€‹
bank
object[]
ā€‹
upi
string
ā€‹
schedule_option
object[]
ā€‹
vendor_type
string
ā€‹
account_type
string
ā€‹
business_type
string
ā€‹
remarks
string
ā€‹
related_docs
object[]

Was this page helpful?

Create vendorUpdate vendor Details