Skip to main content
POST
Available in🇮🇳 India🇺🇸 United States
Use this endpoint to create a payout to a Fund Account of type wallet. Know more about RazorpayX Composite API.

Composite API gives you the flexibility to either create a new Contact and Fund Account or use the existing Contact and Fund Account details (contact_id and fund_account_id) to make a payout. Ensure you allowlist IPs and pass the idempotency key to make a successful payout.

​
Request Parameters

​
string
required
Your customer identifier.
Account details can be found on the RazorpayX Dashboard. For example, 7878780080316316.
Watch Out!
  • This is not your contact’s bank account number. Log in to your RazorpayX Dashboard and go to My Account & Settings → Banking → Customer Identifier.
  • This value is different for Test Mode and Live Mode.
​
integer
required
The payout amount, in paise. For example, pass 1000000 to transfer an amount of ₹10,000. Minimum value is 100 (₹1). Maximum value 1000000 (₹10,000).

The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
​
string
required
The payout currency. Here, it is INR.
​
string
required
The mode to be used to create the payout. Here, it has to be amazonpay.

The payout modes are case-sensitive. When creating payouts using APIs, ensure payout modes are entered in upper case.
​
string
required
The purpose of the payout. Classifications 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.
​
object
required
Details of the contact and fund account to which the payout should be made.
​
string
required
The type of account to be linked to the contact id. Here, the value has to be wallet.
​
object
required
The contact’s wallet details.
​
string
required
The wallet provider. Here, it is amazonpay.
​
string
required
10 digit beneficiary phone number with the country code. For example, +919876543210.
​
string
Beneficiary email address. For example, gaurav.kumar@example.com.
​
string
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.
​
object
required
Details of the contact to whom the payout should be made.
​
string
required
Contact’s name. Minimum 3 characters. Maximum 50 characters. This field is case-sensitive. Supported characters: a-z, A-Z, 0-9, space, ’ , - , _ , / , ( , ) and , .. For example, Gaurav Kumar.
​
string
The contact’s email address. For example, gaurav.kumar@example.com.
​
string
The contact’s phone number. For example, 9000090000.
​
string
Classification for the contact. For example, employee. Classifications are available by default:
  • vendor
  • customer
  • employee
  • self

Additional classifications can be created via the Dashboard and then used in APIs. It is not possible to create new classifications via the API.
​
string
A reference you enter for the contact. Maximum length is 40 characters. For example, Acme Contact ID 12345.
​
object
Notes you can enter for the contact for future reference. This is a key-value pair. For example, "note_key": "Beam me up Scotty".
​
boolean
Possible values:
  • true: The payout is queued when your business account does not have sufficient balance to process the payout.
  • false (default): The payout is never queued. The payout fails if your business account does not have sufficient balance to process the payout.
​
string
Maximum length is 40 characters. A reference you enter for the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.
​
string
Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space. This custom note also appears on the bank statement. If no value is passed for this parameter, it defaults to the Merchant Billing Label.

Enter the important text in the first 9 characters as banks truncate the rest as per their standards.
​
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”.

​
Response Parameters

​
string
The unique identifier of the order.
​
string
The entity being created. Here, it will be payout.
​
string
The unique identifier linked to the fund account. For example, fa_00000000000001.
​
object
Contact and fund account details to which the payout was made.
​
string
The unique identifier linked to the fund account. For example, fa_00000000000001.
​
string
Here it will be fund_account.
​
string
The unique identifier linked to the contact. For example, cont_00000000000001.
​
object
Details of the contact to whom the payout is being made.
​
string
The unique identifier linked to the contact. For example, cont_00000000000001.
​
string
The entity being created. Here, it will be contact.
​
string
The contact’s name. For example, Gaurav Kumar.
​
string
The contact’s phone number. For example, 9000090000.
​
string
The contact’s email address. For example, gaurav.kumar@example.com.
​
string
Classification for the contact being created. For example, employee. Classifications are available by default:
  • vendor
  • customer
  • employee
  • self

Additional Classifications can be created via the Dashboard and then used in APIs. It is not possible to create new Classifications via API.
​
string
A reference you entered for the contact. For example, Acme Contact ID 12345.
​
string
This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.
​
boolean
Possible values:
  • true: active
  • false: inactive
​
object
User-entered notes for internal reference. This is a key-value pair. For example, "note_key": "Beam me up Scotty".
​
integer
Timestamp, in Unix, when the contact was created. For example, 1545320320.
​
string
The type of fund account being created. Here, it will be wallet.
​
object
The contact’s wallet details.
​
string
The wallet provider. Here, it is amazonpay.
​
string
10 digit beneficiary phone number with the country code. For example, +919876543210.
​
string
Beneficiary email address. For example, gaurav.kumar@example.com.
​
string
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.
​
boolean
Possible values:
  • true: active
  • false: inactive
​
string
This value is returned if the fund account was created as part of a bulk upload. For example, batch_00000000000001.
​
integer
Timestamp, in Unix, when the fund account was created. For example, 1545320320.
​
integer
The payout amount, in paise. For example, pass 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.
​
string
The payout’s currency. Here, it is INR.
​
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".
​
integer
The fees for the payout. This value is returned only when the payout moves to the processing state. For example, 5.
​
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.
​
string
The status of the payout. Possible payout states:Refer to Payout Life Cycle.
​
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 RazorpayX Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.
​
string
The unique transaction number linked to a payout. For example, GCID1234567.
​
string
The mode used to make the payout. Available modes is amazonpay. The payout modes are case-sensitive.
​
string
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.
​
string
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.
​
string
This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.
​
object
This parameter returns the current status of the payout. For example, IMPS is not enabled on beneficiary account, Retry with different mode.
​
string
A description for the error. For example, IMPS is not enabled on beneficiary account, please retry with different mode.
​
string
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.
​
string
The error reason. For example, imps_not_allowed. Payout Status Details and Next Steps.
​
integer
Indicates the Unix timestamp when this order was created. For example, 1545320320.
Last modified on October 8, 2026