Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Settlements

Fetch All

API Test Keys

Fetch All Settlements

GET
/v1/settlements/

Click to copy

Use this endpoint to retrieve details of all settlements.

Is this page helpful?

Curl

change language

change language

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

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "setl_DGlQ1Rj8os78Ec",
7
      "entity": "settlement",
8
      "amount": 9973635,
9
      "status": "processed",
10
      "fees": 0,
11
      "tax": 0,
12
      "utr": "1568176960vxp0rj",
13
      "created_at": 1568176960
14
    },
15
    {
16
      "id": "setl_4xbSwsPABDJ8oK",
17
      "entity": "settlement",
18
      "amount": 50000,
19
      "status": "processed",
20
      "fees": 0,
21
      "tax": 0,
22
      "utr": "RZRP173069230702",
23
      "created_at": 1509622306
24
    }
25
  ]
26
}
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, RM 500.00 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.

Error Status: 4xx

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

Solution

from must be between 946684800 and 4765046400.

Error Status: 400

The from UNIX timestamp is not between 946684800 and 4765046400.

Solution

to must be between 946684800 and 4765046400.

Error Status: 400

The to UNIX timestamp is not between 946684800 and 4765046400.

Solution

The count must be at least 1.

Error Status: 400

The count passed is 0.

Solution

Fetch All Settlements

GET
/v1/settlements/

Click to copy

Use this endpoint to retrieve details of all settlements.

Is this page helpful?

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, RM 500.00 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.

Error Status: 4xx

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

Solution

from must be between 946684800 and 4765046400.

Error Status: 400

The from UNIX timestamp is not between 946684800 and 4765046400.

Solution

to must be between 946684800 and 4765046400.

Error Status: 400

The to UNIX timestamp is not between 946684800 and 4765046400.

Solution

The count must be at least 1.

Error Status: 400

The count passed is 0.

Solution

Curl

change language

change language

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

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "setl_DGlQ1Rj8os78Ec",
7
      "entity": "settlement",
8
      "amount": 9973635,
9
      "status": "processed",
10
      "fees": 0,
11
      "tax": 0,
12
      "utr": "1568176960vxp0rj",
13
      "created_at": 1568176960
14
    },
15
    {
16
      "id": "setl_4xbSwsPABDJ8oK",
17
      "entity": "settlement",
18
      "amount": 50000,
19
      "status": "processed",
20
      "fees": 0,
21
      "tax": 0,
22
      "utr": "RZRP173069230702",
23
      "created_at": 1509622306
24
    }
25
  ]
26
}