Fetch All Settlements

To fetch all settlements processed on your Cashfree Account.

Click to view the detailed response parameters and response codes.

Response Parameters

ParameterDescription
statusStatus of API call. Values are - OK and ERROR.
settlementsList of settlements. It will include all the objects listed below in the Settlement Objects section.
messageResponse message (will have the reason when the status is sent as ERROR).
lastIdThe ID of the last transaction returned. Use it in your next request if the current one did not return all the transactions.

Settlement Objects

ParameterDescription
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 CodeStatusDescription
200OKPlease provide a valid appId
200OKPlease provide a valid secretKey
200OKstartDate missing in the request
200OKendDate missing in the request
Language