Skip to main content
Use this endpoint to create a payout to a wallet. You cannot enter a custom narration when creating a payout via Amazon Pay. Know more about RazorpayX Payout API. Ensure you allowlist IPs and pass the idempotency key to make a successful payout.

​
Request

Curl

​
Response

Success

​
Parameters

account_numbermandatory : string 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.
fund_account_idmandatory : string The unique identifier linked to a fund account. For example, fa_00000000000001.amountmandatory : integer The payout amount, in paise. For example, pass 1000000 to transfer an amount of ₹10,000. Minimum value 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.currencymandatory : string The payout currency. Here, it is INR.modemandatory : string The mode to be used to create the payout. Here it has to be amazonpay.Payout modes are case-sensitive. Ensure the payout mode is entered in upper case.purposemandatory : 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.queue_if_low_balanceoptional : 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.
reference_idoptional : 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.notesoptional : 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”.

​
Parameters

id : string The unique identifier linked to 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. 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 currency. Here, it is INR. notes : 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”. fees : integer The fees for the payout. This field is populated 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 field is populated only when the payout moves to the processing state. For example, 1. status : string The status of the payout. Possible payout states: Refer to Payout Life Cycle. utr : string Here, it will be the Amazon Pay gift card ID. For example, GCID1234567. mode : string The mode used to make the payout. Here it will be amazonpay. 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
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 Defaults to the Merchant Billing Label. You cannot enter a custom narration when creating a payout via Amazon Pay. Contact RazorpayX support for more information. batch_id : string This parameter is populated 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 Partner bank.
  • beneficiary_bank: Technical error at beneficiary bank.
  • business: Merchant action required.
  • internal: Technical error at Razorpay’s server.
reason : string The error reason. For example, imps_not_allowed. Payout Status Details and Next Steps. created_at : integer Timestamp, in Unix, when the contact was created. For example, 1545320320.