Skip to main content
Available in🇮🇳 India
Use this endpoint to take one action on a sub-merchant’s payment_gateway product: disable or enable payments, put settlement on hold or release it, or suspend or unsuspend the product. Know more about what each action does and who can reverse it.
Handy Tips
  • action in the path names the action. Send status_reason in the body for suspend, disable_payments and disable_settlement.
  • Repeating the current state returns 200 and changes nothing. An action Razorpay already took keeps Razorpay’s status_reason.
  • Each change sends its webhook, as a change by Razorpay would. Know more about actions webhooks.
  • This endpoint needs the onboarding_accounts_write scope.
Watch Out!
  • You can reverse only what you did. An action with initiated_by: razorpay returns 400 when you try to reverse it.
  • While the product is suspended, every action other than unsuspend returns 400 with product_suspended.
  • suspend, disable_payments and disable_settlement need partner actions switched on for your platform. Otherwise, the call returns 403 with partner_actions_not_enabled. Reversing your own action always works.

Path Parameters

string
required
The unique identifier of the account, acc_ followed by 14 letters or digits. For example, acc_Rk9Xm2Qp7Zt4Nb.
string
required
The action to take. Possible values:
  • suspend: Suspends the product. Both objects stop with your status_reason.
  • unsuspend: Reverses a suspension you set. Both objects return to enabled.
  • disable_payments: Sets payment_acceptance to disabled.
  • enable_payments: Reverses a disable_payments you did.
  • disable_settlement: Sets settlement to on_hold.
  • enable_settlement: Reverses a disable_settlement you did.

Request Parameters

string
required
A unique key you generate for this operation, 16-64 printable ASCII characters long. The same key with the same request returns the first 200 again for 1 hour, with the response header Idempotent-Replayed: true. A refused or failed request holds no key, so a retry with the same key runs again.
object
Why you take the action. Required for suspend, disable_payments and disable_settlement. Do not send it for unsuspend, enable_payments or enable_settlement. On suspend, Razorpay copies it onto payment_acceptance.status_reason and settlement.status_reason.
status_reason.requirement_id is read-only. Sending it returns 400 with field_read_only. The table below lists the request body of each action:

Response Parameters

The response is the account, as Fetch an Account returns it. The fields an action changes are on products.payment_gateway:
string
The product’s status. After activation, the values are:
  • activated: The product is live. Check payment_acceptance and settlement for stops.
  • suspended: Razorpay or you suspended the product. Both objects are stopped with the same status_reason and initiated_by.
object
Whether the sub-merchant can take new payments.
object
Whether Razorpay settles the sub-merchant’s payments.

Errors

Every error returns the Accounts API error envelope, {"error": {...}} with code, description, source, step, reason, field and metadata. Know more about the error object.

Action Errors

Code: 400Reason: field_read_onlyThe body sets a field that only Razorpay sets, such as status_reason.requirement_id. initiated_by and updated_at are also read-only.Solution: Send only status_reason.code and status_reason.description. error.field names the read-only field.
Code: 400Reason: payments_disable_not_reversibleYou called enable_payments while payment_acceptance.initiated_by is razorpay.Solution: Show the sub-merchant status_reason.description. If status_reason.requirement_id is set, answer that requirement. metadata.requirement_id repeats it.
Code: 400Reason: settlement_disable_not_reversibleYou called enable_settlement while settlement.initiated_by is razorpay.Solution: Show the sub-merchant status_reason.description. If status_reason.requirement_id is set, answer that requirement. metadata.requirement_id repeats it.
Code: 400Reason: suspension_not_reversibleYou called unsuspend on a product that Razorpay suspended.Solution: Show the sub-merchant status_reason.description from either object. Answer the requirement in status_reason.requirement_id, if any.
Code: 400Reason: product_suspendedYou called disable_payments, enable_payments, disable_settlement or enable_settlement while the product’s status is suspended.Solution: Reverse the suspension first if you set it, with unsuspend. A suspension by Razorpay can only be reversed by Razorpay.
Code: 403Reason: partner_actions_not_enabledYou called suspend, disable_payments or disable_settlement, and Razorpay has not switched on partner actions for your platform. Reversing your own action (unsuspend, enable_payments, enable_settlement) is never refused for this reason.Solution: Contact Razorpay to switch on partner actions for your platform.

Request Errors

Code: 400Reason: invalid_account_idThe account ID in the path is not acc_ followed by 14 letters or digits.Solution: Send the account ID as acc_ followed by 14 letters or digits, such as acc_Rk9Xm2Qp7Zt4Nb.
Code: 400Reason: invalid_formatX-Idempotency-Key is not 16-64 printable ASCII characters.Solution: Send X-Idempotency-Key with 16-64 printable ASCII characters.
Code: 400Reason: invalid_optionaction is not one of the supported actions. metadata.allowed_values lists the values.Solution: Send an action from metadata.allowed_values.
Code: 400Reason: idempotency_key_reusedYou sent this X-Idempotency-Key before with a different action or different inputs.Solution: Send a new X-Idempotency-Key for a different request. Reuse a key only to retry the same request.
Code: 409Reason: idempotency_in_progressA request with this X-Idempotency-Key is still running. Razorpay stores its result only when it finishes.Solution: Wait for the time in the Retry-After header, then retry with the same key.

Write Errors

Code: 400Reason: missing_headerX-Idempotency-Key is missing. On answers and uploads, a key that is not 16-64 printable ASCII characters also returns this. On partner actions, such a key returns invalid_format.Solution: Send X-Idempotency-Key with 16-64 printable ASCII characters.

Common Errors

Last modified on November 20, 2026