API Test Keys

Fetch Settlements With ID

GET

/v1/settlements/:id

Click to copy

Use this endpoint to retrieve details of a settlement with its id.

Is this page helpful?

Curl

change language

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

Success

Failure

1{
2    "id": "setl_DGlQ1Rj8os78Ec",
3    "entity": "settlement",
4    "amount": 9973635,
5    "status": "processed",
6    "fees": 0,
7    "tax": 0,
8    "utr": "1568176960vxp0rj",
9    "created_at": 1568176960
10}

Path Parameters

id

string

The unique identifier of the settlement to be retrieved.

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, MYR 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

The id provided does not exist.

Error Status: 400

The settlement id does not belong to the requestor or does not exist.

Solution

Fetch Settlements With ID

GET

/v1/settlements/:id

Click to copy

Use this endpoint to retrieve details of a settlement with its id.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the settlement to be retrieved.

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, MYR 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

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

The id provided does not exist.

Error Status: 400

The settlement id does not belong to the requestor or does not exist.

Solution

Curl

change language

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

Success

Failure

1{
2    "id": "setl_DGlQ1Rj8os78Ec",
3    "entity": "settlement",
4    "amount": 9973635,
5    "status": "processed",
6    "fees": 0,
7    "tax": 0,
8    "utr": "1568176960vxp0rj",
9    "created_at": 1568176960
10}