Settlements

The following section will explain the settlement entity and their associated API.

Settlement Entity#

id string: The unique Id of the settlement. Example: "setl_7IZKKI4Pnt2kEe",
entity settlement: The name of the entity.
amount integer: The settlement amount, example 50000.
status string: The status of the settlement. This can these values, processed,
fees integer: The amount charged for processing, example 203.
tax integer: The tax amount charged.
utr string: Unique Transaction Reference number "RZRP173069230703",
created_at timestamp: enoch/integer
created_at integer: epoch timestamp

 Example Entity
Copy  {
    "id": "setl_7IZKKI4Pnt2kEe",
    "entity": "settlement",
    "amount": 50000,
    "status" : "processed",
    "fees": 123,
    "tax": 12,
    "utr": "RZRP173069230703",
    "created_at": 1509622307
  },

Fetch Settlements#

The following endpoint is used for getting all settlements:

/settlements

from timestamp: The timestamp in seconds after which the settlements were created.
to timestamp: The timestamp in seconds before which the settlements were created.
count int (0): The number of the settlements to fetch. Maximum is 100.
skip int (0): The number of settlements to be skipped.

Example Request

Curl
Copycurl -u rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a \
https://api.razorpay.com/v1/settlements/?count=2&skip=1&from=1400826740

 Example Response
Copy{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "setl_7IZKKI4Pnt2kEe",
      "entity": "settlement",
      "amount": 50000,
      "status" : "processed",
      "fees": 123,
      "tax": 12,
      "utr": "RZRP173069230703",
      "created_at": 1509622307
    },
    {
      "id": "setl_4xbSwsPABDJ8oK",
      "entity": "settlement",
      "amount": 50000,
      "status" : "processed",
      "fees": 123,
      "tax": 12,
      "utr": "RZRP173069230702",
      "created_at": 1509622306
    }
  ]
}

Fetch Settlement using ID#

The following endpoint is used retrieve settlements made using settlement id.

/settlements/:id

id string: The id of the settlement to be retrieved

Example Request

Curl
Copycurl -u rzp_test_26ccbdbfe0e84b:69b2e24411e384f91213f22a \
https://api.razorpay.com/v1/settlements/setl_7IZKKI4Pnt2kEe

 Example Response
Copy{
    "id": "setl_7IZKKI4Pnt2kEe",
    "entity": "settlement",
    "amount": 60000,
    "status": "processed",
    "fees": 123,
    "tax": 12,
    "utr": RZRP111111111111,
    "created_at": 1455696913
}

Curl