Fetch a Settlement

Retrieves the details of a specific settlement using its unique identifier.

GET /settlements/{id}

Fetch a Settlement

cURL

curl --request GET \
  --url https://api.razorpay.com/v1/settlements/{id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "id": "setlmnt_FQzNIarBr3mItW",
  "entity": "settlement",
  "amount": 1000000,
  "status": "processed",
  "fees": 2000,
  "tax": 360,
  "utr": "HDFC2104081234567",
  "created_at": 1595491308
}

Authorizations

Authorization · string · header · required

Use your Razorpay Key ID as the username and Key Secret as the password.

Path Parameters

id · string · required

The unique identifier of the settlement to retrieve.

Example:

"setlmnt_FQzNIarBr3mItW"

Response

200

application/json

The settlement details.

A Razorpay Settlement object representing the transfer of funds to your bank account.

id · string

Unique identifier for the settlement.

Example:

"setlmnt_FQzNIarBr3mItW"

entity · string

Entity type, always settlement for settlement objects.

Example:

"settlement"

amount · integer

The total amount settled to your bank account, in the smallest currency sub-unit (e.g., paise for INR).

Example:

1000000

status · enum<string>

The current status of the settlement.

Available options: created, processed, failed

Example:

"processed"

fees · integer

The total Razorpay fees charged for this settlement, in the smallest currency sub-unit.

Example:

2000

tax · integer

The tax amount (GST) charged on the Razorpay fees, in the smallest currency sub-unit.

Example:

360

utr · string

Unique Transaction Reference number assigned by the bank for this settlement transfer.

Example:

"HDFC2104081234567"

created_at · integer

Unix timestamp (in seconds) at which the settlement was created.

Example:

1595491308