Fetch All Settlements

To fetch all settlements processed on your Cashfree Account.

Click to view the detailed response parameters and response codes.

Response Parameters

Parameter

Description

status

Status of API call. Values are - OK and ERROR.

settlements

List of settlements. It will include all the objects listed below in the Settlement Objects section.

message

Response message (will have the reason when the status is sent as ERROR).

lastId

The ID of the last transaction returned. Use it in your next request if the current one did not return all the transactions.

Settlement Objects

Parameter

Description

id (Integer)

Settlement Id (use it to fetch transactions that are part of this settlement).

totalTxAmount (String)

Total transaction amount.

settlementAmount (String)

Amount after deducting the TDR.

adjustment (String)

Any adjustments (because of refunds or disputes).

amountSettled (String)

Amount settled after including the adjustments.

transactionFrom (String)

The transaction included from this day.

transactionTill (String)

Transactions included to this day.

utr (String)

Bank reference number.

settledOn (String)

Time of settlement (this could be different than the credit date shown on the account statement).

Response Codes

Sub Code

Status

Description

200

OK

Please provide a valid appId

200

OK

Please provide a valid secretKey

200

OK

startDate missing in the request

200

OK

endDate missing in the request

Language