Cashfree Payments Developer Documentation

Payments API

v2023-08-01

End Points
Release Notes
Orders
Payments
Payment Links
Refunds
Customers
Easy-Split
Eligibility
Offers
Operations
Partners
Token Vault
softPOS
Simulation
Subscription

Other Versions

v2022-01-01

Upcoming Versions

v2025-01-01 (beta)
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
  - Easy Split Overview
  - Easy Split - Postman Collection
  - End Points
  - Vendors
  - Configuration
  - Settlements
  - Billing
  - Webhooks
- Payment Methods
- Offers
- Token Vault
- Operations
- softPOS
- Simulation
- Subscription

POST

easy-split

vendor-docs

{vendor_id}

curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id} \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --form doc_type=PAN \
  --form 'file=@'\''/Users/john/Downloads/pan.jpeg'\''' \
  --form doc_value=ABCD1234

{
  "vendor_id": "johntest11111",
  "doc_type": "CIN",
  "doc_value": "easySplit/vendorKycDocs/152707/93117/CIN-Fue.pdf",
  "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.

Body

multipart/form-data

doc_type

string

Mention the type of the document you are uploading. Possible values: UIDAI_FRONT, UIDAI_BACK, UIDAI_NUMBER, DL, DL_NUMBER, PASSPORT_FRONT, PASSPORT_BACK, PASSPORT_NUMBER, VOTER_ID, VOTER_ID_NUMBER, PAN, PAN_NUMBER, GST, GSTIN_NUMBER, CIN, CIN_NUMBER, NBFC_CERTIFICATE. If the doc type ends with a number you should add the doc value else upload the doc file.

doc_value

string

Enter the display name of the uploaded file.

file

Select the document that should be uploaded or provide the path of that file. You cannot upload a file that is more than 2MB in size.

Response

200 - application/json

Upload Vendor Document

vendor_id

string

doc_type

string

doc_value

string

status

string

remarks

string

Was this page helpful?

Update vendor Details Get Vendor All Documents Status

curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id} \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --form doc_type=PAN \
  --form 'file=@'\''/Users/john/Downloads/pan.jpeg'\''' \
  --form doc_value=ABCD1234

{
  "vendor_id": "johntest11111",
  "doc_type": "CIN",
  "doc_value": "easySplit/vendorKycDocs/152707/93117/CIN-Fue.pdf",
  "status": "IN_REVIEW",
  "remarks": null
}