Skip to main content
POST
/
settlement
/
recon
Settlement Reconciliation
curl --request POST \
  --url https://sandbox.cashfree.com/pg/settlement/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 '
{
  "pagination": {
    "limit": 10,
    "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
  },
  "filters": {
    "cf_settlement_ids": [
      "4234233"
    ],
    "settlement_utrs": [
      "utr1",
      "utr2"
    ],
    "start_date": "2022-07-20T00:00:00Z",
    "end_date": "2022-07-21T23:59:59Z"
  }
}
'
import requests

url = "https://sandbox.cashfree.com/pg/settlement/recon"

payload = {
    "pagination": {
        "limit": 10,
        "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
    },
    "filters": {
        "cf_settlement_ids": ["4234233"],
        "settlement_utrs": ["utr1", "utr2"],
        "start_date": "2022-07-20T00:00:00Z",
        "end_date": "2022-07-21T23:59:59Z"
    }
}
headers = {
    "x-api-version": "<x-api-version>",
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    pagination: {
      limit: 10,
      cursor: 'eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=='
    },
    filters: {
      cf_settlement_ids: ['4234233'],
      settlement_utrs: ['utr1', 'utr2'],
      start_date: '2022-07-20T00:00:00Z',
      end_date: '2022-07-21T23:59:59Z'
    }
  })
};

fetch('https://sandbox.cashfree.com/pg/settlement/recon', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.cashfree.com/pg/settlement/recon",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pagination' => [
        'limit' => 10,
        'cursor' => 'eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=='
    ],
    'filters' => [
        'cf_settlement_ids' => [
                '4234233'
        ],
        'settlement_utrs' => [
                'utr1',
                'utr2'
        ],
        'start_date' => '2022-07-20T00:00:00Z',
        'end_date' => '2022-07-21T23:59:59Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/pg/settlement/recon"

	payload := strings.NewReader("{\n  \"pagination\": {\n    \"limit\": 10,\n    \"cursor\": \"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\"\n  },\n  \"filters\": {\n    \"cf_settlement_ids\": [\n      \"4234233\"\n    ],\n    \"settlement_utrs\": [\n      \"utr1\",\n      \"utr2\"\n    ],\n    \"start_date\": \"2022-07-20T00:00:00Z\",\n    \"end_date\": \"2022-07-21T23:59:59Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-version", "<x-api-version>")
	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/pg/settlement/recon")
  .header("x-api-version", "<x-api-version>")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pagination\": {\n    \"limit\": 10,\n    \"cursor\": \"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\"\n  },\n  \"filters\": {\n    \"cf_settlement_ids\": [\n      \"4234233\"\n    ],\n    \"settlement_utrs\": [\n      \"utr1\",\n      \"utr2\"\n    ],\n    \"start_date\": \"2022-07-20T00:00:00Z\",\n    \"end_date\": \"2022-07-21T23:59:59Z\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/pg/settlement/recon")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pagination\": {\n    \"limit\": 10,\n    \"cursor\": \"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\"\n  },\n  \"filters\": {\n    \"cf_settlement_ids\": [\n      \"4234233\"\n    ],\n    \"settlement_utrs\": [\n      \"utr1\",\n      \"utr2\"\n    ],\n    \"start_date\": \"2022-07-20T00:00:00Z\",\n    \"end_date\": \"2022-07-21T23:59:59Z\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "cursor": "cursor",
  "limit": 7,
  "data": [
    {
      "event_id": "43594",
      "entity": "recon",
      "event_type": "REFUND",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:06:41+05:30",
      "event_settlement_amount": 200,
      "event_amount": 200,
      "event_status": "SUCCESS",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "refund_note": "nh",
      "refund_id": "REF_bb406ef0-886b-4f96-8fef-ba0a15d901e6",
      "refund_arn": "test",
      "refund_processed_at": "2022-08-16T15:06:41+05:30",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "43594",
      "entity": "recon",
      "event_type": "REFUND_REVERSAL",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:06:41+05:30",
      "event_settlement_amount": 200,
      "event_amount": 200,
      "event_status": "SUCCESS",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "refund_note": "nh",
      "refund_id": "REF_bb406ef0-886b-4f96-8fef-ba0a15d901e6",
      "refund_arn": "test",
      "refund_processed_at": "2022-08-16T15:06:41+05:30",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "272",
      "entity": "recon",
      "event_type": "DISPUTE",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T14:52:55+05:30",
      "event_settlement_amount": 3067.26,
      "event_amount": 3067.26,
      "event_status": "CLOSED",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "closed_in_favor_of": "MERCHANT",
      "dispute_category": "1402-Duplicate Processing",
      "dispute_note": "tesr",
      "dispute_resolved_on": "2022-08-16 14:53:15",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "272",
      "entity": "recon",
      "event_type": "DISPUTE_REVERSAL",
      "sale_type": "CREDIT",
      "event_time": "2022-08-16T14:52:55+05:30",
      "event_settlement_amount": 3067.26,
      "event_amount": 3067.26,
      "event_status": "CLOSED",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "closed_in_favor_of": "MERCHANT",
      "dispute_category": "1402-Duplicate Processing",
      "dispute_note": "tesr",
      "dispute_resolved_on": "2022-08-16 14:53:15",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "885472982",
      "entity": "recon",
      "event_type": "PAYMENT",
      "sale_type": "CREDIT",
      "event_time": "2022-08-16T15:07:56+05:30",
      "event_settlement_amount": 3000,
      "event_amount": 3067.26,
      "event_status": "SUCCESS",
      "event_currency": "INR",
      "order_id": "order_1527072DQsWeQWtwlll6BhI3bt0Fluj81",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "order_amount": 3000,
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "572910",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T15:08:51+05:30",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "45406",
      "entity": "recon",
      "event_type": "OTHER_ADJUSTMENT",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:08:48+05:30",
      "event_settlement_amount": 3,
      "event_amount": 3,
      "event_currency": "INR",
      "cf_settlement_id": "45406",
      "adjustment_remarks": "INSTANT_SETTLEMENT_CHARGE",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "45406",
      "entity": "recon",
      "event_type": "OTHER_ADJUSTMENT",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:08:48+05:30",
      "event_settlement_amount": 0.54,
      "event_amount": 0.54,
      "event_currency": "INR",
      "cf_settlement_id": "45406",
      "adjustment_remarks": "INSTANT_SETTLEMENT_TAX",
      "payment_group": "CREDIT_CARD"
    }
  ]
}
{
  "message": "bad URL, please check API documentation",
  "code": "request_failed",
  "type": "invalid_request_error"
}
{
  "message": "authentication Failed",
  "code": "request_failed",
  "type": "authentication_error"
}
{
  "message": "something is not found",
  "code": "somethind_not_found",
  "type": "invalid_request_error"
}
{
  "message": "order with same id is already present",
  "code": "order_already_exists",
  "type": "invalid_request_error"
}
{
  "message": "something is not found",
  "code": "request_invalid",
  "type": "idempotency_error"
}
{
  "message": "Too many requests from IP. Check headers",
  "code": "request_failed",
  "type": "rate_limit_error"
}
{
  "message": "internal Server Error",
  "code": "internal_error",
  "type": "api_error"
}

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

ā€‹
Content-Type
string

application/json

ā€‹
x-api-version
string
default:2023-08-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.

ā€‹
Accept
string

application/json

Body

application/json

Request Body for the settlement reconciliation

Recon Request Object

ā€‹
pagination
object
required

To fetch the next set of settlements, pass the cursor received in the response to the next API call. To receive the data for the first time, pass the cursor as null. Limit would be number of settlements that you want to receive.

ā€‹
filters
object
required

Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details.

Response

OK

Recon object for settlement

ā€‹
cursor
string

Specifies from where the next set of settlement details should be fetched.

ā€‹
limit
integer

Number of settlements you want to fetch in the next iteration.

ā€‹
data
object[]