Skip to main content
POST
/
easy-split
/
vendors
/
{vendor_id}
/
transfer
Create On Demand Balance 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: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 On Demand Settlement Request Body.

Vendor On Demand Settlement Request

​
transfer_from
string
required

Specify the source of the on-demand balance transfer. Possible values include: MERCHANT (merchant ledger to vendor bank account) or VENDOR (vendor ledger to vendor bank account).

​
transfer_type
string
required

Mention the type of transfer. Possible value: ON_DEMAND.

​
transfer_amount
number<float64>
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
TransferDetails · object
Example:
{
  "vendor_id": "test03",
  "transfer_from": "VENDOR",
  "transfer_type": "ADJUSTMENT",
  "transfer_amount": 10,
  "remark": "Testing",
  "tags": [{ "product": "SHRT" }, { "size": 1 }]
}
​
balances
BalanceDetails · object
Example:
{
  "merchant_id": 152707,
  "vendor_id": "test03",
  "merchant_unsettled": 2442,
  "vendor_unsettled": 4757.42
}
​
charges
ChargesDetails · object
Example:
{
  "service_charges": 2,
  "service_tax": 0.36,
  "amount": 10,
  "billed_to": "MERCHANT",
  "is_postpaid": true
}