POST
/
settlements

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:
2023-08-01
required

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

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

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 to fetch settlement

filters
object
required

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

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.

Response

200 - application/json

Settlement entity object

cf_payment_id
string
cf_settlement_id
string
charges_currency
string

Cashfree refund charges currency for a refund

entity
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

order_amount
number
order_id
string
payment_time
string
service_charge
number
service_tax
number
settlement_amount
number
settlement_currency
string
settlement_id
integer
transfer_id
integer
transfer_time
string
transfer_utr
string