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

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

Instant

Fetch All Payout

API Test Keys

Fetch All Instant Settlements With Payout Details

GET
/v1/settlements/ondemand/?expand[]=ondemand_payouts

Click to copy

Use this endpoint to retrieve payout details as part of the response for all instant settlements.

Watch Out!

Instant Settlements are not available in Malaysia.

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]\
2
- X GET \
3
https://api.razorpay.com/v1/settlements/ondemand?expand[]=ondemand_payouts

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "setlod_FNj7g2YS5J67Rz",
7
      "entity": "settlement.ondemand",
8
      "amount_requested": 200000,
9
      "amount_settled": 199410,
10
      "amount_pending": 0,
11
      "amount_reversed": 0,
12
      "fees": 590,
13
      "tax": 90,
14
      "currency": "INR",
15
      "settle_full_balance": false,
16
      "status": "processed",
17
      "description": "Need this to make vendor payments.",
18
      "notes": {
19
        "notes_key_1": "Tea, Earl Grey, Hot",
20
        "notes_key_2": "Tea, Earl Grey, decaf."
21
      },
22
      "created_at": 1596771429,
23
      "ondemand_payouts": {
24
        "entity": "collection",
25
        "count": 1,
26
        "items": [
27
          {
28
            "id": "setlodp_FNj7g2cbvw8ueO",
29
            "entity": "settlement.ondemand_payout",
30
            "initiated_at": 1596771430,
31
            "processed_at": 1596778752,
32
            "reversed_at": null,
33
            "amount": 200000,
34
            "amount_settled": 199410,
35
            "fees": 590,
36
            "tax": 90,
37
            "utr": "022011173948",
38
            "status": "processed",
39
            "created_at": 1596771429
40
          }
41
        ]
42
      }
43
    },
44
    {
45
      "id": "setlod_FJOp0jOWlalIvt",
46
      "entity": "settlement.ondemand",
47
      "amount_requested": 300000,
48
      "amount_settled": 299114,
49
      "amount_pending": 0,
50
      "amount_reversed": 0,
51
      "fees": 886,
52
      "tax": 136,
53
      "currency": "INR",
54
      "settle_full_balance": false,
55
      "status": "processed",
56
      "description": "Need this to buy stock.",
57
      "notes": {
58
        "notes_key_1": "Tea, Earl Grey, Hot",
59
        "notes_key_2": "Tea, Earl Grey, decaf."
60
      },
61
      "created_at": 1595826576,
62
      "ondemand_payouts": {
63
        "entity": "collection",
64
        "count": 1,
65
        "items": [
66
          {
67
            "id": "setlodp_FJOp0jTqoZdGen",
68
            "entity": "settlement.ondemand_payout",
69
            "initiated_at": 1595826577,
70
            "processed_at": 1595826588,
71
            "reversed_at": null,
72
            "amount": 300000,
73
            "amount_settled": 299114,
74
            "fees": 886,
75
            "tax": 136,
76
            "utr": "020910199316",
77
            "status": "processed",
78
            "created_at": 1595826576
79
          }
80
        ]
81
      }
82
    }
83
  ]
84
}
Query Parameters
expand[]=ondemand_payouts
string

Pass this if you want to fetch payout details as part of the response for all instant settlements.

from
integer

Unix timestamp (in seconds) from when instant settlements are to be retrieved.

to
integer

Unix timestamp (in seconds) till when instant settlements are to be retrieved.

count
integer

Number of instant settlement records to be retrieved.

  • Default value: 10.
  • Possible values: 1 to 100.
  • This can be used for pagination, in combination with skip.

skip
integer

Number of instant 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 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

Fetch All Instant Settlements With Payout Details

GET
/v1/settlements/ondemand/?expand[]=ondemand_payouts

Click to copy

Use this endpoint to retrieve payout details as part of the response for all instant settlements.

Watch Out!

Instant Settlements are not available in Malaysia.

Is this page helpful?

Query Parameters
expand[]=ondemand_payouts
string

Pass this if you want to fetch payout details as part of the response for all instant settlements.

from
integer

Unix timestamp (in seconds) from when instant settlements are to be retrieved.

to
integer

Unix timestamp (in seconds) till when instant settlements are to be retrieved.

count
integer

Number of instant settlement records to be retrieved.

  • Default value: 10.
  • Possible values: 1 to 100.
  • This can be used for pagination, in combination with skip.

skip
integer

Number of instant 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 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

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]\
2
- X GET \
3
https://api.razorpay.com/v1/settlements/ondemand?expand[]=ondemand_payouts

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "setlod_FNj7g2YS5J67Rz",
7
      "entity": "settlement.ondemand",
8
      "amount_requested": 200000,
9
      "amount_settled": 199410,
10
      "amount_pending": 0,
11
      "amount_reversed": 0,
12
      "fees": 590,
13
      "tax": 90,
14
      "currency": "INR",
15
      "settle_full_balance": false,
16
      "status": "processed",
17
      "description": "Need this to make vendor payments.",
18
      "notes": {
19
        "notes_key_1": "Tea, Earl Grey, Hot",
20
        "notes_key_2": "Tea, Earl Grey, decaf."
21
      },
22
      "created_at": 1596771429,
23
      "ondemand_payouts": {
24
        "entity": "collection",
25
        "count": 1,
26
        "items": [
27
          {
28
            "id": "setlodp_FNj7g2cbvw8ueO",
29
            "entity": "settlement.ondemand_payout",
30
            "initiated_at": 1596771430,
31
            "processed_at": 1596778752,
32
            "reversed_at": null,
33
            "amount": 200000,
34
            "amount_settled": 199410,
35
            "fees": 590,
36
            "tax": 90,
37
            "utr": "022011173948",
38
            "status": "processed",
39
            "created_at": 1596771429
40
          }
41
        ]
42
      }
43
    },
44
    {
45
      "id": "setlod_FJOp0jOWlalIvt",
46
      "entity": "settlement.ondemand",
47
      "amount_requested": 300000,
48
      "amount_settled": 299114,
49
      "amount_pending": 0,
50
      "amount_reversed": 0,
51
      "fees": 886,
52
      "tax": 136,
53
      "currency": "INR",
54
      "settle_full_balance": false,
55
      "status": "processed",
56
      "description": "Need this to buy stock.",
57
      "notes": {
58
        "notes_key_1": "Tea, Earl Grey, Hot",
59
        "notes_key_2": "Tea, Earl Grey, decaf."
60
      },
61
      "created_at": 1595826576,
62
      "ondemand_payouts": {
63
        "entity": "collection",
64
        "count": 1,
65
        "items": [
66
          {
67
            "id": "setlodp_FJOp0jTqoZdGen",
68
            "entity": "settlement.ondemand_payout",
69
            "initiated_at": 1595826577,
70
            "processed_at": 1595826588,
71
            "reversed_at": null,
72
            "amount": 300000,
73
            "amount_settled": 299114,
74
            "fees": 886,
75
            "tax": 136,
76
            "utr": "020910199316",
77
            "status": "processed",
78
            "created_at": 1595826576
79
          }
80
        ]
81
      }
82
    }
83
  ]
84
}