Skip to main content
POST
/
easy-split
/
vendors
/
{vendor_id}
/
adjustment
Create Adjustment
curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/vendors/{vendor_id}/adjustment \
  --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": "test_123",
  "adjustment_id": 1234567,
  "amount": 10,
  "type": "CREDIT",
  "remarks": "Testing"
}
'
{
  "message": "Vendor & merchant balances updated",
  "status": "OK"
}

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 key 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 API version to be used

​
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<UUID>

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

application/json

Vendor Adjustment Request Body.

Vendor Adjustment Request Body

​
vendor_id
string
required

The unique identifier of the vendor to whom the adjustment is applied

​
amount
number<float64>
required

The adjustment amount to be applied.

​
type
string
required

The type of adjustment. Possible values: CREDIT or DEBIT. If DEBIT, the adjustment will occur from the Vendor Ledger to the Merchant Ledger; if CREDIT, it will occur from the Merchant Ledger to the Vendor Ledger.

​
adjustment_id
integer<int64>

The unique identifier for the adjustment transaction.

​
remarks
string

Remarks for the adjustment, if any.

Response

Vendor Adjustment Success Response.

Vendor Adjustment Success Response

​
message
string
​
status
string