Available in🇮🇳 India
Use the Method Management API to see which payment methods a sub-merchant account can accept, and to switch them on or off. Razorpay raises any onboarding with the bank or provider for you.
Handy Tips
- Only a partner platform can call this API, for a sub-merchant account mapped to its app. A sub-merchant cannot call it for its own account.
- It works in live mode only. Test credentials are not supported.
- Version 1 covers e-commerce accounts only. For any other business category, the API returns
403withcategory_not_supported.
What You Can Do
- See every payment method and its instruments. Each instrument shows its status, whether customers can pay with it now, how long activation is expected to take and what Razorpay still needs.
- Switch an instrument on or off, one per call. If the instrument first needs onboarding with a bank or provider, switching it on starts that onboarding.
- Supply what is missing. Each instrument lists its open requirements. You answer them with the Onboarding APIs you already use.
Endpoints
Both endpoints sit under the account’spayment_gateway product. Here, … stands for /v3/accounts/{account_id}/products/payment_gateway.
Key Terms
Authenticate
Use the partner key and secret of your app, sent as HTTP Basic credentials on every request. The user name isrzp_live_partner_[CLIENT_ID] and the password is the secret. Your key needs the account_read scope to fetch and account_read_write to enable or disable.
Every request must come from an IP address allowlisted for your app, for an account mapped to your app, where the sub-merchant’s consent is on record. Know more about authenticating your platform.
Integration Steps
- Fetch and Enable Instruments: See the payment methods, switch an instrument on and read the result.
- Activated vs Enabled: Understand the two fields and the four paths an instrument takes to go live.
- Supply Requirements: Answer what Razorpay needs for an instrument.
- Follow Onboarding: Track an instrument to activation with a webhook or by polling.
- Cash on Delivery: Switch full and partial COD on or off.