PG Reconciliation
curl --request POST \
--url https://sandbox.cashfree.com/pg/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": {
"start_date": "2022-07-20T00:00:00Z",
"end_date": "2022-07-21T23:59:59Z"
}
}
'import requests
url = "https://sandbox.cashfree.com/pg/recon"
payload = {
"pagination": {
"limit": 10,
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
},
"filters": {
"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: {start_date: '2022-07-20T00:00:00Z', end_date: '2022-07-21T23:59:59Z'}
})
};
fetch('https://sandbox.cashfree.com/pg/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/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' => [
'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/recon"
payload := strings.NewReader("{\n \"pagination\": {\n \"limit\": 10,\n \"cursor\": \"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\"\n },\n \"filters\": {\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/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 \"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/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 \"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-uid",
"limit": 9,
"data": [
{
"cf_settlement_id": "45345",
"settlement_date": "2022-08-16T14:45:24+05:30",
"sale_type": "CREDIT",
"event_amount": 3000,
"amount_settled": 2796.46,
"event_settlement_amount": 2800,
"event_currency": "INR",
"payment_till": "2022-08-16T14:45:00+05:30",
"event_id": "45345",
"event_type": "SETTLEMENT",
"service_charge": 0,
"service_tax": 0,
"settlement_utr": "PGI45345",
"payment_from": "2022-08-16T14:14:55+05:30",
"settlement_initiated_on": "2022-08-16T14:45:24+05:30",
"adjustment": -200,
"settlement_tax": 0.54,
"event_time": "2022-08-16T14:45:07+05:30",
"settlement_charge": 3,
"entity": "recon",
"remarks": "Settled",
"event_status": "PAID",
"settlement_type": "INSTANT_SETTLEMENT",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45356",
"settlement_date": "2022-08-16T14:45:14+05:30",
"sale_type": "CREDIT",
"event_amount": 0,
"amount_settled": 0,
"event_settlement_amount": 0,
"event_currency": "INR",
"payment_till": "2022-08-16T14:45:14+05:30",
"event_id": "45356",
"event_type": "SETTLEMENT",
"service_charge": 0,
"service_tax": 0,
"settlement_utr": "",
"payment_from": "2022-08-16T14:45:14+05:30",
"adjustment": 0,
"settlement_tax": 0,
"event_time": "2022-08-16T14:45:14+05:30",
"settlement_charge": 0,
"entity": "recon",
"remarks": "No eligible transactions to settle",
"event_status": "PAID",
"settlement_type": "INSTANT_SETTLEMENT",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45373",
"settlement_date": "2022-08-16T14:45:38+05:30",
"sale_type": "CREDIT",
"event_amount": 0,
"amount_settled": 0,
"event_settlement_amount": 0,
"event_currency": "INR",
"payment_till": "2022-08-16T14:45:38+05:30",
"event_id": "45373",
"event_type": "SETTLEMENT",
"service_charge": 0,
"service_tax": 0,
"settlement_utr": "",
"payment_from": "2022-08-16T14:45:38+05:30",
"adjustment": 0,
"settlement_tax": 0,
"event_time": "2022-08-16T14:45:38+05:30",
"settlement_charge": 0,
"entity": "recon",
"remarks": "No eligible transactions to settle",
"event_status": "PAID",
"settlement_type": "INSTANT_SETTLEMENT",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45406",
"split_service_charge": 0,
"sale_type": "DEBIT",
"event_amount": 3067.26,
"payment_service_charge": 0,
"event_settlement_amount": 3067.26,
"event_type": "DISPUTE",
"order_amount": 3000,
"payment_service_tax": 0,
"closed_in_favor_of": "MERCHANT",
"dispute_resolved_on": "2022-08-16 14:53:15",
"event_status": "CLOSED",
"settlement_date": "2022-08-16T14:45:24+05:30",
"customer_phone": "8281554863",
"dispute_note": "tesr",
"event_currency": "INR",
"event_id": "272",
"settlement_utr": "PGI45406",
"customer_email": "manideep.ellur@cashfree.com",
"dispute_category": "1402-Duplicate Processing",
"customer_name": "Manideep",
"split_service_tax": 0,
"vendor_commission": 0,
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"entity": "recon",
"event_time": "2022-08-16T14:52:55+05:30",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45406",
"split_service_charge": 0,
"sale_type": "CREDIT",
"event_amount": 3067.26,
"payment_service_charge": 0,
"event_settlement_amount": 3067.26,
"event_type": "DISPUTE_REVERSAL",
"order_amount": 3000,
"payment_service_tax": 0,
"closed_in_favor_of": "MERCHANT",
"dispute_resolved_on": "2022-08-16 14:53:15",
"event_status": "CLOSED",
"settlement_date": "2022-08-16T14:45:24+05:30",
"customer_phone": "8281554863",
"dispute_note": "tesr",
"event_currency": "INR",
"event_id": "272",
"settlement_utr": "PGI45406",
"customer_email": "manideep.ellur@cashfree.com",
"dispute_category": "1402-Duplicate Processing",
"customer_name": "Manideep",
"split_service_tax": 0,
"vendor_commission": 0,
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"entity": "recon",
"event_time": "2022-08-16T14:52:55+05:30",
"payment_group": "CREDIT_CARD"
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "CREDIT",
"event_amount": 3000,
"adjustment_remarks": "INSTANT_SETTLEMENT_COMPUTE",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:07+05:30",
"entity": "recon",
"event_settlement_amount": 3000,
"payment_group": "CREDIT_CARD"
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "DEBIT",
"event_amount": 3,
"adjustment_remarks": "INSTANT_SETTLEMENT_CHARGE",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:21+05:30",
"entity": "recon",
"event_settlement_amount": 3,
"payment_group": "CREDIT_CARD"
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "DEBIT",
"event_amount": 0.54,
"adjustment_remarks": "INSTANT_SETTLEMENT_TAX",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:21+05:30",
"entity": "recon",
"event_settlement_amount": 0.54
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "DEBIT",
"event_amount": 2796.46,
"adjustment_remarks": "INSTANT_SETTLEMENT_SWEEP",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:21+05:30",
"entity": "recon",
"event_settlement_amount": 2796.46,
"payment_group": "CREDIT_CARD"
}
]
}{
"message": "bad URL, please check API documentation",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "request_failed",
"type": "invalid_request_error"
}{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}{
"message": "something is not found",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "somethind_not_found",
"type": "invalid_request_error"
}{
"message": "order with same id is already present",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "order_already_exists",
"type": "invalid_request_error"
}{
"message": "something is not found",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"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",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "internal_error",
"type": "api_error"
}Settlements
PG Reconciliation
- Use this API to get the payment gateway reconciliation details with date range.
- It will have events for your payment account
POST
/
recon
PG Reconciliation
curl --request POST \
--url https://sandbox.cashfree.com/pg/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": {
"start_date": "2022-07-20T00:00:00Z",
"end_date": "2022-07-21T23:59:59Z"
}
}
'import requests
url = "https://sandbox.cashfree.com/pg/recon"
payload = {
"pagination": {
"limit": 10,
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
},
"filters": {
"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: {start_date: '2022-07-20T00:00:00Z', end_date: '2022-07-21T23:59:59Z'}
})
};
fetch('https://sandbox.cashfree.com/pg/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/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' => [
'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/recon"
payload := strings.NewReader("{\n \"pagination\": {\n \"limit\": 10,\n \"cursor\": \"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\"\n },\n \"filters\": {\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/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 \"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/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 \"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-uid",
"limit": 9,
"data": [
{
"cf_settlement_id": "45345",
"settlement_date": "2022-08-16T14:45:24+05:30",
"sale_type": "CREDIT",
"event_amount": 3000,
"amount_settled": 2796.46,
"event_settlement_amount": 2800,
"event_currency": "INR",
"payment_till": "2022-08-16T14:45:00+05:30",
"event_id": "45345",
"event_type": "SETTLEMENT",
"service_charge": 0,
"service_tax": 0,
"settlement_utr": "PGI45345",
"payment_from": "2022-08-16T14:14:55+05:30",
"settlement_initiated_on": "2022-08-16T14:45:24+05:30",
"adjustment": -200,
"settlement_tax": 0.54,
"event_time": "2022-08-16T14:45:07+05:30",
"settlement_charge": 3,
"entity": "recon",
"remarks": "Settled",
"event_status": "PAID",
"settlement_type": "INSTANT_SETTLEMENT",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45356",
"settlement_date": "2022-08-16T14:45:14+05:30",
"sale_type": "CREDIT",
"event_amount": 0,
"amount_settled": 0,
"event_settlement_amount": 0,
"event_currency": "INR",
"payment_till": "2022-08-16T14:45:14+05:30",
"event_id": "45356",
"event_type": "SETTLEMENT",
"service_charge": 0,
"service_tax": 0,
"settlement_utr": "",
"payment_from": "2022-08-16T14:45:14+05:30",
"adjustment": 0,
"settlement_tax": 0,
"event_time": "2022-08-16T14:45:14+05:30",
"settlement_charge": 0,
"entity": "recon",
"remarks": "No eligible transactions to settle",
"event_status": "PAID",
"settlement_type": "INSTANT_SETTLEMENT",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45373",
"settlement_date": "2022-08-16T14:45:38+05:30",
"sale_type": "CREDIT",
"event_amount": 0,
"amount_settled": 0,
"event_settlement_amount": 0,
"event_currency": "INR",
"payment_till": "2022-08-16T14:45:38+05:30",
"event_id": "45373",
"event_type": "SETTLEMENT",
"service_charge": 0,
"service_tax": 0,
"settlement_utr": "",
"payment_from": "2022-08-16T14:45:38+05:30",
"adjustment": 0,
"settlement_tax": 0,
"event_time": "2022-08-16T14:45:38+05:30",
"settlement_charge": 0,
"entity": "recon",
"remarks": "No eligible transactions to settle",
"event_status": "PAID",
"settlement_type": "INSTANT_SETTLEMENT",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45406",
"split_service_charge": 0,
"sale_type": "DEBIT",
"event_amount": 3067.26,
"payment_service_charge": 0,
"event_settlement_amount": 3067.26,
"event_type": "DISPUTE",
"order_amount": 3000,
"payment_service_tax": 0,
"closed_in_favor_of": "MERCHANT",
"dispute_resolved_on": "2022-08-16 14:53:15",
"event_status": "CLOSED",
"settlement_date": "2022-08-16T14:45:24+05:30",
"customer_phone": "8281554863",
"dispute_note": "tesr",
"event_currency": "INR",
"event_id": "272",
"settlement_utr": "PGI45406",
"customer_email": "manideep.ellur@cashfree.com",
"dispute_category": "1402-Duplicate Processing",
"customer_name": "Manideep",
"split_service_tax": 0,
"vendor_commission": 0,
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"entity": "recon",
"event_time": "2022-08-16T14:52:55+05:30",
"payment_group": "CREDIT_CARD",
"forex_conversion_handling_charge": 11.12,
"forex_conversion_handling_tax": 1.12,
"charges_currency": "INR"
},
{
"cf_settlement_id": "45406",
"split_service_charge": 0,
"sale_type": "CREDIT",
"event_amount": 3067.26,
"payment_service_charge": 0,
"event_settlement_amount": 3067.26,
"event_type": "DISPUTE_REVERSAL",
"order_amount": 3000,
"payment_service_tax": 0,
"closed_in_favor_of": "MERCHANT",
"dispute_resolved_on": "2022-08-16 14:53:15",
"event_status": "CLOSED",
"settlement_date": "2022-08-16T14:45:24+05:30",
"customer_phone": "8281554863",
"dispute_note": "tesr",
"event_currency": "INR",
"event_id": "272",
"settlement_utr": "PGI45406",
"customer_email": "manideep.ellur@cashfree.com",
"dispute_category": "1402-Duplicate Processing",
"customer_name": "Manideep",
"split_service_tax": 0,
"vendor_commission": 0,
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"entity": "recon",
"event_time": "2022-08-16T14:52:55+05:30",
"payment_group": "CREDIT_CARD"
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "CREDIT",
"event_amount": 3000,
"adjustment_remarks": "INSTANT_SETTLEMENT_COMPUTE",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:07+05:30",
"entity": "recon",
"event_settlement_amount": 3000,
"payment_group": "CREDIT_CARD"
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "DEBIT",
"event_amount": 3,
"adjustment_remarks": "INSTANT_SETTLEMENT_CHARGE",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:21+05:30",
"entity": "recon",
"event_settlement_amount": 3,
"payment_group": "CREDIT_CARD"
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "DEBIT",
"event_amount": 0.54,
"adjustment_remarks": "INSTANT_SETTLEMENT_TAX",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:21+05:30",
"entity": "recon",
"event_settlement_amount": 0.54
},
{
"cf_settlement_id": "45345",
"event_id": "45345",
"event_type": "OTHER_ADJUSTMENT",
"sale_type": "DEBIT",
"event_amount": 2796.46,
"adjustment_remarks": "INSTANT_SETTLEMENT_SWEEP",
"event_currency": "INR",
"event_time": "2022-08-16T14:45:21+05:30",
"entity": "recon",
"event_settlement_amount": 2796.46,
"payment_group": "CREDIT_CARD"
}
]
}{
"message": "bad URL, please check API documentation",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "request_failed",
"type": "invalid_request_error"
}{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}{
"message": "something is not found",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "somethind_not_found",
"type": "invalid_request_error"
}{
"message": "order with same id is already present",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "order_already_exists",
"type": "invalid_request_error"
}{
"message": "something is not found",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"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",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "internal_error",
"type": "api_error"
}Authorizations
XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey
Client app ID. You can find your app id in the merchant dashboard.
Client secret key. You can find your secret in the merchant dashboard.
Headers
application/json
API version to be used
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.
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.
application/json
Body
application/json
Request Body for the reconciliation
Recon object
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I