Payouts Entity
The Payouts' Entity has the following parameters:
Is this page helpful?
Sample Entity
1{2"id": "pout_00000000000001",3"entity": "payout",4"fund_account_id": "fa_00000000000001",5"amount": 1000000,6"currency": "INR",7"notes": {8"notes_key_1":"Tea, Earl Grey, Hot",9"notes_key_2":"Tea, Earl Grey… decaf."10},11"fees": 0,12"tax": 0,13"status": "queued",14"utr": null,15"mode": "IMPS",16"purpose": "refund",17"reference_id": "Acme Transaction ID 12345",18"narration": "Acme Corp Fund Transfer",19"batch_id": null,20"status_details": {21"description": "Payout is queued as there is insufficient balance in your business account to process the payout",22"source": "business",23"reason": "low_balance"24}25"created_at": 154538303726}
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 enabled)rejected
(if you have enabled)processing
processed
cancelled
reversed
failed
Know more about
and .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
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 Entity
The Payouts' 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:
queued
pending
(if you have enabled)rejected
(if you have enabled)processing
processed
cancelled
reversed
failed
Know more about
and .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
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
.
Sample Entity
1{2"id": "pout_00000000000001",3"entity": "payout",4"fund_account_id": "fa_00000000000001",5"amount": 1000000,6"currency": "INR",7"notes": {8"notes_key_1":"Tea, Earl Grey, Hot",9"notes_key_2":"Tea, Earl Grey… decaf."10},11"fees": 0,12"tax": 0,13"status": "queued",14"utr": null,15"mode": "IMPS",16"purpose": "refund",17"reference_id": "Acme Transaction ID 12345",18"narration": "Acme Corp Fund Transfer",19"batch_id": null,20"status_details": {21"description": "Payout is queued as there is insufficient balance in your business account to process the payout",22"source": "business",23"reason": "low_balance"24}25"created_at": 154538303726}