API Test Keys

Fetch Instant Settlement With ID

GET

/v1/settlements/ondemand/:id

Click to copy

Use this endpoint to retrieve the details of a particular Instant Settlement.

Is this page helpful?

Success

Failure

1{
2  "id": "setlod_FNj7g2YS5J67Rz",
3  "entity": "settlement.ondemand",
4  "amount_requested": 200000,
5  "amount_settled": 199410,
6  "amount_pending": 0,
7  "amount_reversed": 0,
8  "fees": 590,
9  "tax": 90,
10  "currency": "INR",
11  "settle_full_balance": false,
12  "status": "processed",
13  "description": "Need this to make vendor payments.",
14  "notes": {
15    "notes_key_1": "Tea, Earl Grey, Hot",
16    "notes_key_2": "Tea, Earl Grey, decaf."
17  },
18  "created_at": 1596771429
19}

Path Parameters

id

string

The unique identifier for the instant settlement transaction. For example, setlod_FNj7g2YS5J67Rz.

Response Parameters

id

string

The unique identifier of the instant settlement transaction. For example, setlod_FNj7g2YS5J67Rz.

entity

string

Indicates the type of entity. Here it is settlement.ondemand.

amount_requested

integer

The settlement amount, in paise, requested by you. For example, 200000.

amount_settled

integer

Total amount (minus fees and tax), in paise, settled to the bank account. For example, 199410.

amount_pending

integer

Portion of the requested amount, in paise, yet to be settled to you.

amount_reversed

integer

Portion of the requested amount, in paise, that was not settled to you. This amount is reversed to your PG current balance.

fees

integer

Total amount (fees+tax), in paise, deducted for the instant settlement. For example, 590.

tax

integer

Total tax, in paise, charged for the fee component. For example, 90.

currency

string

The 3-letter ISO currency code for the settlement. Here it is INR.

settle_full_balance

boolean

Possible values:

true: Razorpay will settle the maximum amount possible. Values passed in the amount parameter are ignored.
false (default): Razorpay will settle the amount requested in the amount parameter.

status

string

Indicates the state of the instant settlement. Possible values:

created: The instant settlement request has been created.
initiated: The instant settlement process has been initiated.
partially_processed: The instant settlement is being processed.
processed: The instant settlement has been processed and the amount has been transferred to your bank account.
reversed: The instant settlement could not be processed for some reason and the amount has been transferred back to your PG balance.

description

string

This is a custom note you can pass for the instant settlement for your reference. For example, Need this to make vendor payments..

notes

object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer

Unix timestamp at which the instant settlement was created. For example, 1596771429.

ondemand_payouts

object

List of payouts created for the instant settlement.

Show child parameters (3)

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 Instant Settlement With ID

GET

/v1/settlements/ondemand/:id

Click to copy

Use this endpoint to retrieve the details of a particular Instant Settlement.

Is this page helpful?

Path Parameters

id

string

The unique identifier for the instant settlement transaction. For example, setlod_FNj7g2YS5J67Rz.

Response Parameters

id

string

The unique identifier of the instant settlement transaction. For example, setlod_FNj7g2YS5J67Rz.

entity

string

Indicates the type of entity. Here it is settlement.ondemand.

amount_requested

integer

The settlement amount, in paise, requested by you. For example, 200000.

amount_settled

integer

Total amount (minus fees and tax), in paise, settled to the bank account. For example, 199410.

amount_pending

integer

Portion of the requested amount, in paise, yet to be settled to you.

amount_reversed

integer

Portion of the requested amount, in paise, that was not settled to you. This amount is reversed to your PG current balance.

fees

integer

Total amount (fees+tax), in paise, deducted for the instant settlement. For example, 590.

tax

integer

Total tax, in paise, charged for the fee component. For example, 90.

currency

string

The 3-letter ISO currency code for the settlement. Here it is INR.

settle_full_balance

boolean

Possible values:

true: Razorpay will settle the maximum amount possible. Values passed in the amount parameter are ignored.
false (default): Razorpay will settle the amount requested in the amount parameter.

status

string

Indicates the state of the instant settlement. Possible values:

created: The instant settlement request has been created.
initiated: The instant settlement process has been initiated.
partially_processed: The instant settlement is being processed.
processed: The instant settlement has been processed and the amount has been transferred to your bank account.
reversed: The instant settlement could not be processed for some reason and the amount has been transferred back to your PG balance.

description

string

This is a custom note you can pass for the instant settlement for your reference. For example, Need this to make vendor payments..

notes

object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer

Unix timestamp at which the instant settlement was created. For example, 1596771429.

ondemand_payouts

object

List of payouts created for the instant settlement.

Show child parameters (3)

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

Success

Failure

1{
2  "id": "setlod_FNj7g2YS5J67Rz",
3  "entity": "settlement.ondemand",
4  "amount_requested": 200000,
5  "amount_settled": 199410,
6  "amount_pending": 0,
7  "amount_reversed": 0,
8  "fees": 590,
9  "tax": 90,
10  "currency": "INR",
11  "settle_full_balance": false,
12  "status": "processed",
13  "description": "Need this to make vendor payments.",
14  "notes": {
15    "notes_key_1": "Tea, Earl Grey, Hot",
16    "notes_key_2": "Tea, Earl Grey, decaf."
17  },
18  "created_at": 1596771429
19}