> ## Documentation Index
> Fetch the complete documentation index at: https://doc-test-my.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Instant Settlements Entity

> Know about the instant settlements entity parameters and their descriptions.

The Instant Settlements entity has the following parameters:

<ResponseExample>
  ```json Entity theme={null}
  {
    "id":"setlod_FNj7g2YS5J67Rz",
    "entity":"settlement.ondemand",
    "amount_requested":200000,
    "amount_settled":0,
    "amount_pending":199410,
    "amount_reversed":0,
    "fees":590,
    "tax":90,
    "currency":"INR",
    "settle_full_balance":false,
    "status":"initiated",
    "description":"Need this to make vendor payments.",
    "notes":{
      "notes_key_1":"Tea, Earl Grey, Hot",
      "notes_key_2":"Tea, Earl Grey… decaf."
    },
    "created_at":1596771429,
    "ondemand_payouts":{
      "entity":"collection",
      "count":1,
      "items":[
        {
          "id":"setlodp_FNj7g2cbvw8ueO",
          "entity":"settlement.ondemand_payout",
          "initiated_at":null,
          "processed_at":null,
          "reversed_at":null,
          "amount":200000,
          "amount_settled":null,
          "fees":590,
          "tax":90,
          "utr":null,
          "status":"created",
          "created_at":1596771429
        }
      ]
    }
  }
  ```
</ResponseExample>

<ResponseField name="id" type="string">
  The unique identifier of the instant settlement transaction. For example, `setlod_FNj7g2YS5J67Rz`.
</ResponseField>

<ResponseField name="entity" type="string">
  Indicates the type of entity. Here it is `settlement.ondemand`.
</ResponseField>

<ResponseField name="amount_requested" type="integer">
  The settlement amount, in paise, requested by you. For example, `200000`.
</ResponseField>

<ResponseField name="amount_settled" type="integer">
  Total amount (minus fees and tax), in paise, settled to the bank account. For example, `199410`.
</ResponseField>

<ResponseField name="amount_pending" type="integer">
  Portion of the requested amount, in paise, yet to be settled to you.
</ResponseField>

<ResponseField name="amount_reversed" type="integer">
  Portion of the requested amount, in paise, that was not settled to you. This amount is reversed to your PG current balance.
</ResponseField>

<ResponseField name="fees" type="integer">
  Total amount (fees+tax), in paise, deducted for the instant settlement. For example, `590`.
</ResponseField>

<ResponseField name="tax" type="integer">
  Total tax, in paise, charged for the fee component. For example, `90`.
</ResponseField>

<ResponseField name="currency" type="string">
  The 3-letter ISO currency code for the settlement. Here it is `INR`.
</ResponseField>

<ResponseField name="settle_full_balance" type="boolean">
  Indicates whether Razorpay will settle maximum amount or not. 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.
</ResponseField>

<ResponseField name="status" type="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.
</ResponseField>

<ResponseField name="description" type="string">
  This is a custom note you can pass for the instant settlement for your reference. For example, `Need this to make vendor payments.`.
</ResponseField>

<ResponseField name="notes" type="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”`.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Unix timestamp at which the instant settlement was created. For example, `1596771429`.
</ResponseField>

<ResponseField name="ondemand_payouts" type="object">
  List of payouts created for the instant settlement.
</ResponseField>

<ResponseField name="entity" type="string">
  Indicates the type of `ondemand_payouts` entity. Here it is `collection`.
</ResponseField>

<ResponseField name="count" type="integer">
  The number of items in the array. For example, `1`.
</ResponseField>

<ResponseField name="items" type="array">
  List of payouts created for the instant settlement.
</ResponseField>

<ResponseField name="id" type="string">
  The unique identifier for the payout. For example, `setlodp_FNj7g2cbvw8ueO`.
</ResponseField>

<ResponseField name="entity" type="string">
  Indicates the type of `items` entity. Here it is `settlement.ondemand_payout`.
</ResponseField>

<ResponseField name="initiated_at" type="integer">
  Unix timestamp at which the payout was initiated. For example, `1596771430`.
</ResponseField>

<ResponseField name="processed_at" type="integer">
  Unix timestamp at which the payout was processed. For example, `1596778752`.
</ResponseField>

<ResponseField name="reversed_at" type="integer">
  Unix timestamp at which the payout was reversed. For example, `1596778752`.
</ResponseField>

<ResponseField name="amount" type="integer">
  The amount, in paise, settled through this payout. For example, `200000`.
</ResponseField>

<ResponseField name="amount_settled" type="integer">
  Amount (minus fees and tax), in paise, settled through this payout. For example, `199410`.
</ResponseField>

<ResponseField name="fees" type="integer">
  Amount (fees+tax), in paise, deducted for this payout. For example, `590`.
</ResponseField>

<ResponseField name="tax" type="integer">
  Tax charged, in paise, for the fee component. For example, `90`.
</ResponseField>

<ResponseField name="utr" type="string">
  The unique transaction number linked to a payout.
</ResponseField>

<ResponseField name="status" type="string">
  Status of the payout. Possible values:

  * `created`: The payout has been created.
  * `initiated`: The payout has been initiated.
  * `processed`: The payout has been processed. The amount has been transferred to your bank account.
  * `reversed`: The payout has been reversed. The amount has been transferred back to your PG balance.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Unix timestamp at which the payout was created.
</ResponseField>