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

X

Payouts Approval

Entity

API Test Keys

Payouts Approval Entity

The Payouts Approval Entity has the following parameters:


Is this page helpful?

Entity

1
{
2
  "id": "pout_00000000000001",
3
  "entity": "payout",
4
  "fund_account_id": "fa_00000000000001",
5
  "amount": 1000000,
6
  "currency": "INR",
7
  "notes": {
8
    "note_key": "Beam me up Scotty"
9
  },
10
  "fees": 590,
11
  "tax": 90,
12
  "status": "processing",
13
  "purpose": "payout",
14
  "utr": null,
15
  "mode": "NEFT",
16
  "reference_id": "Acme Transaction ID 12345",
17
  "narration": "Acme Corp Fund Transfer",
18
  "batch_id": null,
19
  "failure_reason": null,
20
  "created_at": 1630261800,
21
  "fee_type": "",
22
  "status_details": {
23
    "reason": "beneficiary_bank_confirmation_pending",
24
    "description": "Payout is pending confirmation from the beneficiary bank. Payout status will be confirmed by end of day 1st July, 2023",
25
    "source": "beneficiary_ban"
26
  }
27
}
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:

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
  • card

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.

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.

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.

Show child parameters (3)

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.

Payouts Approval Entity

The Payouts Approval Entity has the following parameters:


Is this page helpful?

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:

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
  • card

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.

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.

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.

Show child parameters (3)

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.

Entity

1
{
2
  "id": "pout_00000000000001",
3
  "entity": "payout",
4
  "fund_account_id": "fa_00000000000001",
5
  "amount": 1000000,
6
  "currency": "INR",
7
  "notes": {
8
    "note_key": "Beam me up Scotty"
9
  },
10
  "fees": 590,
11
  "tax": 90,
12
  "status": "processing",
13
  "purpose": "payout",
14
  "utr": null,
15
  "mode": "NEFT",
16
  "reference_id": "Acme Transaction ID 12345",
17
  "narration": "Acme Corp Fund Transfer",
18
  "batch_id": null,
19
  "failure_reason": null,
20
  "created_at": 1630261800,
21
  "fee_type": "",
22
  "status_details": {
23
    "reason": "beneficiary_bank_confirmation_pending",
24
    "description": "Payout is pending confirmation from the beneficiary bank. Payout status will be confirmed by end of day 1st July, 2023",
25
    "source": "beneficiary_ban"
26
  }
27
}