> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Payouts Approval Entity

> Check the entity code for Payouts Approval APIs.

Available in
🇮🇳 India
🇲🇾 Malaysia
🇺🇸 United States

The Payouts Approval Entity has the following parameters:

```json Entity theme={null}
{
  "id": "pout_00000000000001",
  "entity": "payout",
  "fund_account_id": "fa_00000000000001",
  "amount": 1000000,
  "currency": "INR",
  "notes": {
    "note_key": "Beam me up Scotty"
  },
  "fees": 590,
  "tax": 90,
  "status": "processing",
  "purpose": "payout",
  "utr": null,
  "mode": "NEFT",
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "batch_id": null,
  "failure_reason": null,
  "created_at": 1630261800,
  "fee_type": "",
  "status_details": {
    "reason": "beneficiary_bank_confirmation_pending",
    "description": "Payout is pending confirmation from the beneficiary bank. Payout status will be confirmed by end of day 1st July, 2023",
    "source": "beneficiary_ban"
  }
}
```

**id** `string`

The unique identifier of the payout. For example, `pout_00000000000001`.

**entity** `string`

The entity being created. Here, it will be `payout`.

**fund\_account\_id** `string`

The unique identifier linked to the fund account. For example, `fa_00000000000001`.

**amount** `integer`

The payout amount, in paise. For example, if you want to transfer ₹10,000, pass `1000000`. Minimum value `100`. \
The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.

**currency** `string`

The payout's currency. Here, it is `INR`.

**notes** `array of objects`

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”`.

**fees** `integer`

The fees for the payout. This value is returned only when the payout moves to the `processing` state. For example, `5`.

**tax** `integer`

The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the `processing` state. For example, `1`.

**status** `string`

The status of the payout. Possible payout states:

* `queued`
* `pending` (if you have Approval Workflow enabled)
* `rejected` (if you have Approval Workflow enabled)
* `processing`
* `processed`
* `cancelled`
* `reversed`
* `failed`

Know more about Payout States and Payout Status Details.

**utr** `string`

The unique transaction number linked to a payout. For example, `HDFCN00000000001`.

**mode** `string`

The mode used to make the payout. Available modes:

* `NEFT`
* `RTGS`
* `IMPS` \\

The payout modes are case-sensitive.

**purpose** `string`

The purpose of the payout that is being created. The following classifications are available in the system by default:

* `refund`
* `cashback`
* `payout`
* `salary`
* `utility bill`
* `vendor bill` \\

Additional purposes for payouts can be created via the Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.

**reference\_id** `string`

Maximum length is 40 characters. A user-generated reference given to the payout. For example, `Acme Transaction ID 12345`. You can use this field to store your own transaction ID, if any.

**debit\_account\_number** `string`

The account from which the payout was processed. For example, `002281300012871`.

**narration** `string`

Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: `a-z`, `A-Z`, `0-9` and space. \
&#x20;\
&#x20;If no value is passed for this parameter, it defaults to the Merchant Billing Label. Ensure that the most important text forms the first 9 characters as banks may truncate the rest as per their standards.

**batch\_id** `string`

This value is returned if the contact was created as part of a bulk upload. For example, `batch_00000000000001`.

**status\_details** `object`

This parameter returns the current status of the payout. For example, `IMPS is not enabled on beneficiary account, Retry with different mode.`

**description** `string`

A description for the error. For example, `IMPS is not enabled on beneficiary account, please retry with different mode`.

**source** `string`

Possible values:

* `gateway`: Technical error at Razorpay Curlec Partner bank.
* `beneficiary_bank`: Technical error at beneficiary bank.
* `business`: Merchant action required.
* `internal`: Technical error at Razorpay Curlec's server.

**reason** `string`

The error reason. For example, `imps_not_allowed`. Know more about Payout Status Details and Next Steps.

**created\_at** `integer`

Indicates the Unix timestamp when this payout was created.

**fee\_type** `string`

Indicates the fee type charged for the payout. Possible values is `free_payout`.
