Available in🇮🇳 India
Accept Razorpay’s terms of service on a test account, submit the product and force every outcome after submission before you go live.
The sub-merchant accepts Razorpay’s terms of service in your UI. You submit by sending the acceptance. The product’s outcome follows, in the same response for most products.
Start with the overview for test credentials and headers.
1. Test Mode Coverage
Test Mode Differences
The table below lists how submission behaves in each mode:What You Can Test
The table below lists the areas to test for submission:Endpoint Coverage in Test Mode
The table below lists the endpoints this page uses:2. Before You Begin
Prepare the following before you run the scenarios:- Meet every requirement except
accept_terms_of_service. - Pick the outcome you want to test with the settlement bank account, from the table below.
Outcomes After Submission
Pick the outcome with the settlement bank account number. Each of these accounts verifies whatever the holder’s name, so it works with every business type. Any other verified account gives the default:activated in the response, or edd_pending without a Central KYC Records Registry (CKYC) record.
The table below lists the settlement accounts that force each outcome:
Registered business types can use a business-name suffix instead.
_REJECT (such as SUNRISE ENTERPRISES_REJECT) rejects the product, and _EDD asks for video KYC. The suffix does not affect the name matches.
Sample Request
Submission is the last update. Show the sub-merchant Razorpay’s terms of service for theaccept_terms_of_service requirement. Once they accept in your UI, send their ip and device_fingerprint_id in the product’s terms_of_service_acceptance.
Curl
terms_of_service_acceptance:
Know more about the request parameters.
Sample Response
Razorpay records the acceptance and submits the product. The response carries the acceptance’saccepted_at. Most products come back activated in this response, as below.
Response: HTTP 200
Response: HTTP 200
Response
3. Test Scenarios
Work through these scenarios in order. Each row gives the trigger to send and what to confirm in the response.3.1 Scenarios
Live scenarios work in test mode today. Coming soon scenarios are not available in test mode yet. The table below lists 14 scenarios. 2 are live and 12 are coming soon:| # | Scenario | Trigger | What to confirm |
|---|---|---|---|
| 1 | Accept the terms and submit Coming soon | Individual A, with every requirement but the terms met | Show Razorpay’s terms of service to the sub-merchant, who accepts. Send their ip and device_fingerprint_id, as in the sample request. Confirm activated, with accepted_at on the acceptance. |
| 2 | Submit with something still due Live | The acceptance before the bank account | Confirm 400 step_not_due with metadata.due. |
| 3 | A missing field Live | No device_fingerprint_id | Confirm 400 invalid_request, with field naming it. |
| 4 | No CKYC record: video KYC Coming soon | PAN ABCPD7891B | Submit. Confirm edd_pending in the response, and create_video_kyc_link due as an action. |
| 5 | Video KYC approved Coming soon | #4, then Approved on the hosted test page | Run create_video_kyc_link. The link is in the response’s metadata. Open the url and pick Approved. Confirm under_review, then activated about 5 sec later. |
| 6 | Video KYC rejected Coming soon | #4, then Rejected on the hosted test page | Pick Rejected. Confirm under_review, then rejected about 5 sec later. |
| 7 | Video KYC unable to verify Coming soon | #4, then Unable to verify on the hosted test page | Pick Unable to verify. Confirm the product stays edd_pending, and create_video_kyc_link is still due. Run it again for a new call. |
| 8 | Rejected Coming soon | Settlement account 000000000002, or business_name ending _REJECT | Submit. Confirm under_review in the response, then rejected about 5 sec later. |
| 9 | Video KYC by value Coming soon | Settlement account 000000000004, or business_name ending _EDD | Submit. Confirm edd_pending in the response. |
| 10 | Needs clarification Coming soon | Settlement account 000000000003 | Submit. Confirm under_review, then needs_clarification about 5 sec later. Answer it, as on Needs Clarification. |
| 11 | Held in review Coming soon | Settlement account 000000000005 | Send it. Its verification is deferred, and bank_account clears. Submit and confirm under_review. Confirm it stays under_review, then turns activated after 5 min. |
| 12 | Locked after submission Coming soon | #4, then a new bank account | Confirm 409 field_locked with metadata.status: edd_pending. |
| 13 | A rejected product Coming soon | #8, then any update or action | Confirm 409 field_locked on updates and 400 step_not_due on actions. |
| 14 | Suspended after activation Coming soon | Settlement account 000000000006 | Submit and confirm activated. Confirm suspended about 60 sec later, with status_reason.code: website_review_failed and the website due again. Send https://curlec.com, and the product is activated again. |
3.2 Scenario Details
The details below expand the scenarios that need more than one step:1. Accept the Terms and Submit
1. Accept the Terms and Submit
Before you begin: Meet every requirement, so only
accept_terms_of_service is due.How to test:- Show Razorpay’s terms of service to the sub-merchant, unchanged.
- When they accept in your UI, record their IP address and your device fingerprint for the session.
- Send both values, as in the sample request.
activated and requirements is empty. The acceptance carries ip, device_fingerprint_id and accepted_at.Webhooks: account.product.activated.Your integration should: Send the acceptance only after the sub-merchant accepts, with their own ip. Keep the accepted_at time Razorpay returns.3. A Missing Field
3. A Missing Field
How to test: Send
terms_of_service_acceptance with only ip.Expected result: HTTP 400 with reason: invalid_request and field: products.payment_gateway.terms_of_service_acceptance.device_fingerprint_id. Nothing is recorded.Your integration should: Collect both values before you send, because both are required.4. No CKYC Record: Video KYC
4. No CKYC Record: Video KYC
Before you begin: Use Individual B (PAN
ABCPD7891B) with everything else sent. See Individual.How to test: Submit, as in #1.Expected result: edd_pending in the response, with 1 requirement: create_video_kyc_link, requirement_type: action. The KYC details are locked.Webhooks: account.product.edd_pending.Your integration should: Show the sub-merchant why a call is needed, and show the link (#5). Do not report the outcome of the call yourself.5. Video KYC Approved
5. Video KYC Approved
Before you begin: Complete #4.How to test:
- Run
create_video_kyc_link. The link is in the response’smetadata, as in scenario 10 on Actions. - Open the
url. The hosted test page shows the outcomes. - Pick Approved.
- Fetch the account.
under_review, then activated about 5 sec later.Webhooks: account.requirements.updated, account.product.under_review, then account.product.activated.Your integration should: Open the link inside your product. The link expires and works only for this account.8. Rejected
8. Rejected
Before you begin: Use any test business with settlement account
000000000002. Or use Proprietorship A with business_name set to SUNRISE ENTERPRISES_REJECT. See Proprietorship.How to test:- Submit.
- Fetch after 5 sec.
under_review in the response, then rejected, with requirements empty. No further changes are accepted.Webhooks: account.product.under_review, then account.product.rejected.Your integration should: Tell the sub-merchant the application was not approved, and stop offering changes.11. Held in Review
11. Held in Review
Before you begin: Get an account ready to submit.How to test:
- Send settlement account
000000000005. Itsverification.statusisdeferred,error_codeisnullandbank_accountclears. - Submit.
under_review in the response. The product stays there for 5 min while a reviewer decides, then moves to activated.Webhooks: account.product.under_review, then account.product.activated.Your integration should: Show under_review as waiting, never as live or failed. No timeout in your code should move the sub-merchant to a failure state.3.3 Errors to Handle
Every error returns the same object. Branch onerror.reason and error.field, because the description can change. The overview lists the errors every operation shares.
The table below lists the errors submission returns:
4. Common Integration Gaps
These mistakes most often stall an onboarding or leave an account in the wrong state after go-live. The Test with column points to the scenario that proves you have handled each one. Terms The table below lists the gaps in handling the terms:
After submission
The table below lists the gaps after submission: