Get All Settlements
curl --request POST \
--url https://sandbox.cashfree.com/pg/settlements \
--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"
],
"settlement_status": [
"SUCCESS",
"PENDING_WITH_BANK"
],
"start_date": "2022-07-20T00:00:00Z",
"end_date": "2022-07-21T23:59:59Z"
}
}
'import requests
url = "https://sandbox.cashfree.com/pg/settlements"
payload = {
"pagination": {
"limit": 10,
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
},
"filters": {
"cf_settlement_ids": ["4234233"],
"settlement_utrs": ["utr1", "utr2"],
"settlement_status": ["SUCCESS", "PENDING_WITH_BANK"],
"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'],
settlement_status: ['SUCCESS', 'PENDING_WITH_BANK'],
start_date: '2022-07-20T00:00:00Z',
end_date: '2022-07-21T23:59:59Z'
}
})
};
fetch('https://sandbox.cashfree.com/pg/settlements', 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/settlements",
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'
],
'settlement_status' => [
'SUCCESS',
'PENDING_WITH_BANK'
],
'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/settlements"
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 \"settlement_status\": [\n \"SUCCESS\",\n \"PENDING_WITH_BANK\"\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/settlements")
.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 \"settlement_status\": [\n \"SUCCESS\",\n \"PENDING_WITH_BANK\"\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/settlements")
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 \"settlement_status\": [\n \"SUCCESS\",\n \"PENDING_WITH_BANK\"\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": null,
"limit": 2,
"data": [
{
"cf_settlement_id": "312048765",
"status": "SUCCESS",
"status_description": "The settlement amount has been credited to your bank account.",
"settlement_utr": "CB0312048765",
"payment_from": "2026-01-05T10:22:14+05:30",
"payment_till": "2026-01-18T08:47:52+05:30",
"settlement_initiated_on": "2026-01-20T09:15:22+05:30",
"settlement_processed_on": "2026-01-20T09:15:22+05:30",
"payment_amount": 1000,
"pg_service_charge": 0,
"pg_service_tax": 0,
"adjustment": -100,
"settlement_charge": 0,
"settlement_tax": 0,
"split_service_charge": 0,
"split_service_tax": 0,
"vendor_commission": 0,
"amount_settled": 900,
"charge_type": "PREPAID",
"settlement_type": "NORMAL_SETTLEMENT"
},
{
"cf_settlement_id": "489271036",
"status": "PENDING_WITH_BANK",
"status_description": "The settlement has been processed by Cashfree's partner bank and is waiting for a credit confirmation from your bank.",
"settlement_utr": "CB0489271036",
"payment_from": "2026-01-05T10:22:14+05:30",
"payment_till": "2026-01-18T08:47:52+05:30",
"settlement_initiated_on": "2026-01-21T11:30:05+05:30",
"settlement_processed_on": "",
"payment_amount": 1000,
"pg_service_charge": 0,
"pg_service_tax": 0,
"adjustment": -100,
"settlement_charge": 0,
"settlement_tax": 0,
"split_service_charge": 0,
"split_service_tax": 0,
"vendor_commission": 0,
"amount_settled": 900,
"charge_type": "PREPAID",
"settlement_type": "NORMAL_SETTLEMENT"
}
]
}{
"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": "something_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
Get All Settlements
Use this API to get all settlement details by specifying the settlement ID, settlement UTR, settlement status or date range. Returns settlements of all statuses including SUCCESS, PENDING, PENDING_WITH_CASHFREE, PENDING_WITH_BANK and FAILED.
POST
/
settlements
Get All Settlements
curl --request POST \
--url https://sandbox.cashfree.com/pg/settlements \
--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"
],
"settlement_status": [
"SUCCESS",
"PENDING_WITH_BANK"
],
"start_date": "2022-07-20T00:00:00Z",
"end_date": "2022-07-21T23:59:59Z"
}
}
'import requests
url = "https://sandbox.cashfree.com/pg/settlements"
payload = {
"pagination": {
"limit": 10,
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
},
"filters": {
"cf_settlement_ids": ["4234233"],
"settlement_utrs": ["utr1", "utr2"],
"settlement_status": ["SUCCESS", "PENDING_WITH_BANK"],
"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'],
settlement_status: ['SUCCESS', 'PENDING_WITH_BANK'],
start_date: '2022-07-20T00:00:00Z',
end_date: '2022-07-21T23:59:59Z'
}
})
};
fetch('https://sandbox.cashfree.com/pg/settlements', 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/settlements",
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'
],
'settlement_status' => [
'SUCCESS',
'PENDING_WITH_BANK'
],
'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/settlements"
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 \"settlement_status\": [\n \"SUCCESS\",\n \"PENDING_WITH_BANK\"\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/settlements")
.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 \"settlement_status\": [\n \"SUCCESS\",\n \"PENDING_WITH_BANK\"\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/settlements")
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 \"settlement_status\": [\n \"SUCCESS\",\n \"PENDING_WITH_BANK\"\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": null,
"limit": 2,
"data": [
{
"cf_settlement_id": "312048765",
"status": "SUCCESS",
"status_description": "The settlement amount has been credited to your bank account.",
"settlement_utr": "CB0312048765",
"payment_from": "2026-01-05T10:22:14+05:30",
"payment_till": "2026-01-18T08:47:52+05:30",
"settlement_initiated_on": "2026-01-20T09:15:22+05:30",
"settlement_processed_on": "2026-01-20T09:15:22+05:30",
"payment_amount": 1000,
"pg_service_charge": 0,
"pg_service_tax": 0,
"adjustment": -100,
"settlement_charge": 0,
"settlement_tax": 0,
"split_service_charge": 0,
"split_service_tax": 0,
"vendor_commission": 0,
"amount_settled": 900,
"charge_type": "PREPAID",
"settlement_type": "NORMAL_SETTLEMENT"
},
{
"cf_settlement_id": "489271036",
"status": "PENDING_WITH_BANK",
"status_description": "The settlement has been processed by Cashfree's partner bank and is waiting for a credit confirmation from your bank.",
"settlement_utr": "CB0489271036",
"payment_from": "2026-01-05T10:22:14+05:30",
"payment_till": "2026-01-18T08:47:52+05:30",
"settlement_initiated_on": "2026-01-21T11:30:05+05:30",
"settlement_processed_on": "",
"payment_amount": 1000,
"pg_service_charge": 0,
"pg_service_tax": 0,
"adjustment": -100,
"settlement_charge": 0,
"settlement_tax": 0,
"split_service_charge": 0,
"split_service_tax": 0,
"vendor_commission": 0,
"amount_settled": 900,
"charge_type": "PREPAID",
"settlement_type": "NORMAL_SETTLEMENT"
}
]
}{
"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": "something_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 key 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 to get the settlements.
Request to fetch settlement.
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
Specify either the Settlement ID, Settlement UTR, settlement status, or start date and end date to fetch the settlement details.
Show child attributes
Show child attributes
Response
OK
Paginated response for Get All Settlements API.
Was this page helpful?
āI