POST
/
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"
    ],
    "start_date": "2022-07-20T00:00:00Z",
    "end_date": "2022-07-21T23:59:59Z"
  }
}'
{
  "cf_payment_id": "553338",
  "order_id": "order-12-127",
  "entity": "settlement",
  "order_amount": 100,
  "payment_time": "2021-07-13T13:13:59+05:30",
  "service_charge": 10,
  "service_tax": 1.8,
  "settlement_amount": 88.2,
  "cf_settlement_id": "6121238",
  "transfer_id": 238,
  "transfer_time": "2021-07-25T12:57:52+05:30",
  "transfer_utr": "N87912312",
  "order_currency": "INR",
  "settlement_currency": "INR",
  "forex_conversion_handling_charge": 11.12,
  "forex_conversion_handling_tax": 1.12,
  "forex_conversion_rate": 84.24,
  "charges_currency": "INR"
}

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 in the merchant dashboard.

Headers

​
Content-Type
string

application/json

​
x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD

​
x-request-id
string

Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.

​
x-idempotency-key
string

An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.

​
Accept
string

application/json

Body

application/json
Request Body to get the settlements

Request to fetch settlement

​
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

200
application/json
OK

Settlement entity object

​
cf_payment_id
string
​
cf_settlement_id
string
​
settlement_currency
string
​
order_id
string
​
entity
string
​
order_amount
number
​
payment_time
string
​
service_charge
number
​
service_tax
number
​
settlement_amount
number
​
settlement_id
integer
​
transfer_id
integer
​
transfer_time
string
​
transfer_utr
string
​
forex_conversion_handling_charge
number

Cashfree forex conversion charges for refund processing

​
forex_conversion_handling_tax
number

Cashfree forex conversion tax for refund processing

​
forex_conversion_rate
number

Cashfree forex conversion rate for refund processing

​
charges_currency
string

Cashfree refund charges currency for a refund

Was this page helpful?