List Settlements
Returns a list of settlements. Settlements represent the transfer of funds from Razorpay to your bank account. Use the count and skip parameters to paginate through results.
GET
/
settlements
List Settlements
curl --request GET \
--url https://api.razorpay.com/v1/settlements \
--header 'Authorization: Basic <encoded-value>'const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.razorpay.com/v1/settlements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.razorpay.com/v1/settlements"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.razorpay.com/v1/settlements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.razorpay.com/v1/settlements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.razorpay.com/v1/settlements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.razorpay.com/v1/settlements")
.header("Authorization", "Basic <encoded-value>")
.asString();{
"entity": "collection",
"count": 2,
"items": [
{
"id": "setlmnt_FQzNIarBr3mItW",
"entity": "settlement",
"amount": 1000000,
"status": "processed",
"fees": 2000,
"tax": 360,
"utr": "HDFC2104081234567",
"created_at": 1595491308
},
{
"id": "setlmnt_GRaOJbsCs4nJuX",
"entity": "settlement",
"amount": 500000,
"status": "created",
"fees": 1000,
"tax": 180,
"utr": null,
"created_at": 1595577708
}
]
}{
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "The amount must be at least 100 paise.",
"source": "business",
"step": "payment_initiation",
"reason": "input_validation_failed",
"metadata": {}
}
}Authorizations
Use your Razorpay Key ID as the username and Key Secret as the password.
Query Parameters
The number of items to return per page. Maximum value is 100.
Required range:
x <= 100Example:
25
The number of items to skip from the beginning of the list, used for pagination.
Example:
10
Was this page helpful?
⌘I
List Settlements
curl --request GET \
--url https://api.razorpay.com/v1/settlements \
--header 'Authorization: Basic <encoded-value>'const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.razorpay.com/v1/settlements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.razorpay.com/v1/settlements"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.razorpay.com/v1/settlements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.razorpay.com/v1/settlements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.razorpay.com/v1/settlements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.razorpay.com/v1/settlements")
.header("Authorization", "Basic <encoded-value>")
.asString();{
"entity": "collection",
"count": 2,
"items": [
{
"id": "setlmnt_FQzNIarBr3mItW",
"entity": "settlement",
"amount": 1000000,
"status": "processed",
"fees": 2000,
"tax": 360,
"utr": "HDFC2104081234567",
"created_at": 1595491308
},
{
"id": "setlmnt_GRaOJbsCs4nJuX",
"entity": "settlement",
"amount": 500000,
"status": "created",
"fees": 1000,
"tax": 180,
"utr": null,
"created_at": 1595577708
}
]
}{
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "The amount must be at least 100 paise.",
"source": "business",
"step": "payment_initiation",
"reason": "input_validation_failed",
"metadata": {}
}
}