Skip to main content
POST
/
split
/
order
/
vendor
/
recon
Get Split and Settlement Details by OrderID v2.0
curl --request POST \
  --url https://sandbox.cashfree.com/pg/split/order/vendor/recon \
  --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 '
{
  "filters": {
    "start_date": null,
    "end_date": null,
    "order_ids": [
      "order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X"
    ]
  }
}
'
{
  "cursor": null,
  "data": [
    {
      "amount": 900000,
      "settlement_eligibility_time": "2024-01-08 11:30:00",
      "merchant_order_id": "order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X",
      "tx_time": "2024-01-08 17:00:00",
      "settled": "NO",
      "entity_id": "14910180251",
      "merchant_settlement_utr": "N/A",
      "currency": "INR",
      "sale_type": "CREDIT",
      "customer_name": "Manideep",
      "customer_email": "manideep.ellur@cashfree.com",
      "customer_phone": "8281554863",
      "merchant_vendor_commission": "810000.00",
      "split_service_charge": "900.00",
      "split_service_tax": "162.00",
      "pg_service_tax": "4698.90",
      "pg_service_charge": "26105.00",
      "pg_charge_postpaid": "1",
      "merchant_settlement_id": "N/A",
      "added_on": "2024-01-08 17:00:00",
      "tags": "tags",
      "entity_type": "transaction",
      "settlement_initiated_on": "N/A",
      "settlement_time": "N/A",
      "order_splits": [
        {
          "split": [
            {
              "merchant_vendor_id": "vendor20Lakh",
              "percentage": 90,
              "tags": null
            }
          ],
          "created_at": "2024-01-08 17:00:01"
        }
      ],
      "eligible_split_balance": "0.00"
    },
    {
      "amount": 810000,
      "merchant_order_id": "order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X",
      "tx_time": "2024-01-08 17:00:00",
      "settled": "YES",
      "entity_id": "305293",
      "merchant_vendor_id": "vendor20Lakh",
      "currency": "INR",
      "sale_type": "CREDIT",
      "customer_name": "Manideep",
      "customer_email": "manideep.ellur@cashfree.com",
      "customer_phone": "8281554863",
      "added_on": "2024-01-08 17:00:01",
      "entity_type": "vendor_commission",
      "past_settlements": [
        {
          "settlement_id": 54878,
          "settlement_initiated_on": "2024-01-08 17:14:38",
          "status": "SUCCESS"
        }
      ],
      "vendor_split_service_charges": "0.00",
      "vendor_split_service_tax": "0.00",
      "vendor_settlement_time": "2024-01-08 17:14:39",
      "vendor_settlement_initiated_on": "2024-01-08 17:14:38",
      "vendor_settlement_eligibility_time": "2024-01-08 16:50:00",
      "vendor_settlement_id": "54878",
      "vendor_settlement_utr": "1704714278653975",
      "vendor_commission": "810000.00",
      "vendor_pg_service_charge": "0.00",
      "vendor_pg_service_tax": "0.00",
      "status": "N/A"
    }
  ],
  "limit": 2
}

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.

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

Body

application/json

Request parameters to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.

​
filters
object
required

Provide the filter object details.

​
pagination
object
required

Set limit based on your requirement. Pagination limit will fetch a set of orders, next set of orders can be generated using the cursor shared in previous response of the same API.

Response

Success response for getting all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.

ES Order Recon Response.

​
cursor
string
​
data
object[]
​
limit
integer