Available in🇮🇳 India🇲🇾 Malaysia🇸🇬 Singapore🇺🇸 United States
The Contact, Fund Account and Payout Entities have the following parameters:
Classification for the contact being created. For example,
Additional Classifications can be created via the Dashboard and then used in APIs. It is not possible to create new Classifications via API.
employee. Classifications are available by default:vendorcustomeremployeeself
Additional Classifications can be created via the Dashboard and then used in APIs. It is not possible to create new Classifications via API.
This value is returned if the contact was created as part of a bulk upload. For example,
batch_00000000000001.User-entered notes for internal reference. This is a key-value pair. For example,
"note_key": "Beam me up Scotty".Wallet holder’s name. Between 4 and 120 characters. This field is case-sensitive. Supported characters:
a-z, A-Z, 0-9, space, ’ , - , _ , / , ( , ) and , .. For example, Gaurav Kumar.This value is returned if the fund account was created as part of a bulk upload. For example,
batch_00000000000001.The payout amount, in paise. For example, pass
The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
1000000 to transfer an amount of ₹10,000. Minimum value 100. The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
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".The fees for the payout. This value is returned only when the payout moves to the
processing state. For example, 5.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.The status of the payout. Possible payout states:
queuedpending(if you have Approval Workflow enabled)rejected(if you have Approval Workflow enabled)processingprocessedcancelledreversed
The purpose of the payout that is being created. The following classifications are available in the system by default:
Additional purposes for payouts can be created via the RazorpayX Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.
refundcashbackpayoutsalaryutility billvendor bill
Additional purposes for payouts can be created via the RazorpayX Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.
The mode used to make the payout. Available modes is
amazonpay. The payout modes are case-sensitive.A user-generated reference given to the payout. Maximum length is 40 characters. For example,
Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space.
You cannot enter a custom narration when creating a payout via Amazon Pay.
You cannot enter a custom narration when creating a payout via Amazon Pay.
This value is returned if the contact was created as part of a bulk upload. For example,
batch_00000000000001.This parameter returns the current status of the payout. For example,
IMPS is not enabled on beneficiary account, Retry with different mode.A description for the error. For example,
IMPS is not enabled on beneficiary account, please retry with different mode.Possible values:
gateway: Technical error at Razorpay Partner bank.beneficiary_bank: Technical error at beneficiary bank.business: Merchant action required.internal: Technical error at Razorpay’s server.
The error reason. For example,
imps_not_allowed. Payout Status Details and Next Steps.