Vendor Reconciliation API

This API allows you to fetch vendor reconciliation details by using different filters. Use the appropriate filters based on your requirements. After you receive a VENDOR_SETTLEMENT_SUCCESS webhook confirmation, wait 15 minutes before you call this API endpoint.

• View Split Order Details Using Settlement ID: Retrieve details of split orders within a settlement by Settlement ID.
• Vendor Recon for a Time Period: Fetch reconciliation details for all vendors within a specific time interval.
• Vendor Recon Using Vendor ID & Time Interval: Get reconciliation details for a specific vendor within a given time interval.

POST /recon/vendor

Vendor Reconciliation API

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/pg/recon/vendor \
  --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 '
{
  "pagination": {
    "limit": 100,
    "cursor": null
  },
  "filters": {
    "merchant_vendor_id": "test01",
    "start_date": "2024-09-01T00:00:00Z",
    "end_date": "2024-09-26T23:59:59Z"
  }
}
'

200

PG

{
  "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTI4ODVdLCJlbXB0eSI6ZmFsc2V9LCJyZXBvcnRUeXBlIjoidmVuZG9yX2FkanVzdG1lbnRfcmVjb24ifQ==",
  "data": [
    {
      "amount": 70,
      "settlement_eligibility_time": "2023-08-18 13:47:09",
      "merchant_order_id": "order_1527072U9JADzyG7V93d9xG7goO6xo8C6",
      "tx_time": "2023-08-18 13:32:09",
      "settlement_id": 51709,
      "settled": true,
      "fee": "NA",
      "tax": "NA",
      "entity_id": "2148545831",
      "type": "transaction",
      "merchant_vendor_id": "test03",
      "added_on_time": "2023-08-18 13:32:21",
      "settlement_time": "2023-08-22 10:34:11",
      "settlement_utr": "1692680651484925",
      "currency": "INR",
      "debit": "NA",
      "credit": "70.0",
      "refund_arn": "order_1527072U9JADzyG7V93d9xG7goO6xo8C6"
    },
    {
      "amount": 2500,
      "settlement_eligibility_time": "2023-08-18 18:25:04",
      "merchant_order_id": "order_1527072U9qz76SXfmFPbu1Z1BfTa4lNW5",
      "tx_time": "2023-08-18 18:10:04",
      "settlement_id": 51709,
      "settled": true,
      "fee": "NA",
      "tax": "NA",
      "entity_id": "2148548184",
      "type": "transaction",
      "merchant_vendor_id": "test03",
      "added_on_time": "2023-08-18 18:10:06",
      "settlement_time": "2023-08-22 10:34:11",
      "settlement_utr": "1692680651484925",
      "currency": "INR",
      "debit": "NA",
      "credit": "2500.0",
      "refund_arn": "order_1527072U9qz76SXfmFPbu1Z1BfTa4lNW5"
    },
    {
      "amount": 2500,
      "settlement_eligibility_time": "2023-08-18 18:33:00",
      "merchant_order_id": "order_1527072U9rwyUDlUqtkYpRyGtu3A6tfgy",
      "tx_time": "2023-08-18 18:18:00",
      "settlement_id": 51709,
      "settled": true,
      "fee": "NA",
      "tax": "NA",
      "entity_id": "2148548225",
      "type": "transaction",
      "merchant_vendor_id": "test03",
      "added_on_time": "2023-08-18 18:18:02",
      "settlement_time": "2023-08-22 10:34:11",
      "settlement_utr": "1692680651484925",
      "currency": "INR",
      "debit": "NA",
      "credit": "2500.0",
      "refund_arn": "order_1527072U9rwyUDlUqtkYpRyGtu3A6tfgy"
    },
    {
      "settlement_eligibility_time": "NA",
      "merchant_order_id": "NA",
      "tx_time": "2023-08-18 17:54:55",
      "settlement_id": 51678,
      "fee": "10.0",
      "tax": "1.8",
      "entity_id": "51678",
      "type": "vendor_settlement",
      "merchant_vendor_id": "test03",
      "added_on_time": "2023-08-18 17:54:55",
      "currency": "INR",
      "debit": "0.0",
      "credit": "NA",
      "refund_arn": "NA"
    },
    {
      "settlement_eligibility_time": "NA",
      "merchant_order_id": "NA",
      "tx_time": "2023-08-18 17:58:49",
      "settlement_id": 51680,
      "settled": true,
      "fee": "10.0",
      "tax": "1.8",
      "entity_id": "51680",
      "type": "vendor_settlement",
      "merchant_vendor_id": "test03",
      "added_on_time": "2023-08-18 17:58:49",
      "settlement_time": "2023-08-18 17:58:51",
      "settlement_utr": "1692361731372244",
      "currency": "INR",
      "debit": "0.0",
      "credit": "NA",
      "refund_arn": "NA"
    }
  ],
  "limit": 15
}

Vendor Recon API usage

When you use the Vendor Recon API, follow these guidelines:

• Don’t call the API with a failed settlement_id. If a settlement has failed and the amount remains unsettled, the API returns no data.
• If the amount is later settled under a new (successful) settlement_id, the API returns data for the successful settlement instead.

This is expected behavior.

Authorizations

XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey

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.

Content-Type · string

application/json.

Body

application/json

Vendor Recon Request body.

Vendor Recon Request body.

pagination · object · required

The merchant can set pagination limits based on their use case. The minimum limit is 10. Pagination will fetch a set of records, and the next set of records can be generated using the cursor provided in response to the first request for all reconciliation APIs.

Show child attributes

filters · object · required

Specify the filters for the desired use case.

Show child attributes

Response

200

application/json

Terminal created.

Fetch Vendor Recon details success response.

cursor · string

data · object[]

Show child attributes

limit · integer