Fetch All Settlements

Fetch All Settlements using Razorpay Settlements API.

GET /v1/settlements/

Curl

curl -u <YOUR_KEY>:<YOUR_SECRET>\
- X GET \
https://api.razorpay.com/v1/settlements/

Success

{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "setl_DGlQ1Rj8os78Ec",
      "entity": "settlement",
      "amount": 9973635,
      "status": "processed",
      "fees": 0,
      "tax": 0,
      "utr": "1568176960vxp0rj",
      "created_at": 1568176960
    },
    {
      "id": "setl_4xbSwsPABDJ8oK",
      "entity": "settlement",
      "amount": 50000,
      "status": "processed",
      "fees": 0,
      "tax": 0,
      "utr": "RZRP173069230702",
      "created_at": 1509622306
    }
  ]
}

Use this endpoint to retrieve details of all settlements.

Curl

curl -u <YOUR_KEY>:<YOUR_SECRET>\
- X GET \
https://api.razorpay.com/v1/settlements/

Success

{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "setl_DGlQ1Rj8os78Ec",
      "entity": "settlement",
      "amount": 9973635,
      "status": "processed",
      "fees": 0,
      "tax": 0,
      "utr": "1568176960vxp0rj",
      "created_at": 1568176960
    },
    {
      "id": "setl_4xbSwsPABDJ8oK",
      "entity": "settlement",
      "amount": 50000,
      "status": "processed",
      "fees": 0,
      "tax": 0,
      "utr": "RZRP173069230702",
      "created_at": 1509622306
    }
  ]
}

Query Parameters

from · integer

Unix timestamp (in seconds) from when settlements are to be fetched.

to · integer

Unix timestamp (in seconds) till when settlements are to be fetched.

count · integer

Number of settlement records to be fetched.

• Default value: 10.
• Possible value: 1 to 100.
• This can be used for pagination, in combination with skip.

skip · integer

Number of settlement records to be skipped.

• Default value: 0
• This can be used for pagination, in combination with count.

Response Parameters

id · string

The unique identifier of the settlement transaction. For example, setl_7IZKKI4Pnt2kEe

entity · string

Indicates the type of entity. Here, it is settlement.

amount · integer

The amount to be settled (in the smallest unit of currency). For example, ₹500 will be 50000.

status · string

Indicates the settlement states. Possible values:

• created
• processed
• failed

fees · integer

This is the total fee charged for processing all payments received from customers settled to you in this settlement transaction. In case of a normal settlement the fee charge will be 0.

tax · integer

The total tax, in currency subunits, charged on the fees collected to process all payments received from customers settled to you in this settlement transaction. In case of a normal settlement the tax charge will be 0.

utr · string

The Unique Transaction Reference (UTR) number available across banks, which can be used to track a particular settlement in your bank account. For example, 1597813219e1pq6w.

created_at · integer

Unix timestamp at which the settlement transaction was created.

Errors

The API {key/secret} provided is invalid.

Code: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution: The API keys must be active and entered correctly with no whitespace before or after.

from must be between 946684800 and 4765046400.

Code: 400

The from UNIX timestamp is not between 946684800 and 4765046400.

Solution: Use a valid UNIX timestamp between 946684800 and 4765046400.

to must be between 946684800 and 4765046400.

Code: 400

The to UNIX timestamp is not between 946684800 and 4765046400.

Solution: Use a valid UNIX timestamp between 946684800 and 4765046400.

The count must be at least 1.

Code: 400

The count passed is 0.

Solution: Ensure that count is at least 1.

count or skip must be a non-negative integer.

Code: 400

A negative value was passed for the count or skip query parameter. The API responds with count: must be no less than 0. or skip: must be no less than 0. respectively.

Solution: Pass count as an integer between 1 and 100, and skip as an integer greater than or equal to 0.

count, skip, from, or to must be a valid integer.

Code: 400

A non-integer value (for example a string like abc, or a human-readable date like 2024-01-01) was passed for one of the pagination or range query parameters. The API responds with a message of the form <field>: strconv.Atoi: parsing "<value>": invalid syntax.

Solution: Pass all four query parameters (count, skip, from, to) as integers. from and to must be UNIX-epoch seconds, not human-readable dates.