Skip to main content
POST
/
easy-split
/
vendors
/
{vendor_id}
/
transfer
Create On Demand Transfer
curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/vendors/{vendor_id}/transfer \
  --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 '{
  "transfer_from": "VENDOR",
  "transfer_type": "ON_DEMAND",
  "transfer_amount": 10,
  "remark": "Testing",
  "tags": {
    "size": 1,
    "product": "SHRT"
  }
}'
{
  "settlement_id": 1050232,
  "transfer_details": {
    "vendor_id": "test03",
    "transfer_from": "VENDOR",
    "transfer_type": "ON_DEMAND",
    "transfer_amount": 10,
    "remark": "Testing",
    "tags": {
      "product": "Paneer Tikka",
      "size": "L",
      "AWB": "PNRTKKA12334"
    }
  },
  "balances": {
    "merchant_id": 152707,
    "vendor_id": "test03",
    "merchant_unsettled": 2442,
    "vendor_unsettled": 4757.42
  },
  "charges": {
    "service_charges": 2,
    "service_tax": 0.36,
    "amount": 10,
    "billed_to": "MERCHANT",
    "is_postpaid": true
  }
}

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:2025-01-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<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

Adjust Vendor Balance Request Body.

Adjust Vendor Balance Request

ā€‹
transfer_from
string
required

Mention to whom you want to transfer the on demand balance. Possible values - MERCHANT, VENDOR.

ā€‹
transfer_type
string
required

Mention the type of transfer. Possible values: ON_DEMAND.

ā€‹
transfer_amount
number
required

Mention the on demand transfer amount.

ā€‹
remark
string

Mention remarks if any for the on demand transfer.

ā€‹
tags
object

Provide additional data fields using tags.

Response

Adjust Vendor Balance Success Response.

Adjust Vendor Balance Response

ā€‹
settlement_id
number
ā€‹
transfer_details
object
Example:
{
  "vendor_id": "test03",
  "transfer_from": "VENDOR",
  "transfer_type": "ADJUSTMENT",
  "transfer_amount": 10,
  "remark": "Testing",
  "tags": [{ "product": "SHRT" }, { "size": 1 }]
}
ā€‹
balances
object
Example:
{
  "merchant_id": 152707,
  "vendor_id": "test03",
  "merchant_unsettled": 2442,
  "vendor_unsettled": 4757.42
}
ā€‹
charges
object
Example:
{
  "service_charges": 2,
  "service_tax": 0.36,
  "amount": 10,
  "billed_to": "MERCHANT",
  "is_postpaid": true
}