Available in🇮🇳 India
Send what is due on a test account and check each verification outcome. Test the ordering rules and locks before you go live.
PATCH /v1/accounts/{account_id} sends what is due. Values apply in the order sent. Concurrent updates to 1 account apply one at a time.
Start with the overview for test credentials and headers.
1. Test Mode Coverage
Test Mode Differences
The table below lists how updates behave in each mode:What You Can Test
The table below lists the areas to test on this endpoint: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:- Create an account, as in scenario 1 on Create an Account.
- Send each input’s
field_pathas a path in the body. - Send the phone and email codes (
phone_otp,email_otp) at the top level of the body.
Sample Request
The request below sends the PAN of test business Individual A. The response is the whole account, within 3 sec. A slow check staysin_progress and settles later.
Curl
Sample Response
The PAN comes back verified, andckyc_fetch is due next.
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 20 scenarios. 7 are live and 13 are coming soon:| # | Scenario | Trigger | What to confirm |
|---|---|---|---|
| 1 | Send the business type Live | individual | Send it. Confirm the requirements change to those of an individual. |
| 2 | Verify the phone and email Coming soon | 000007 | Run send_phone_otp and send_email_otp, as on Actions. Each response lists the code to send. Send phone_otp and email_otp. Confirm both contacts are verified. |
| 3 | A wrong code Coming soon | 123456 | Send it as phone_otp. Confirm HTTP 200, and that phone_otp is still due. |
| 4 | PAN verified Coming soon | ABCPD1234A | Send the PAN, as in the sample request. Confirm verified, the name and ckyc_fetch due. |
| 5 | The CKYC code Coming soon | Any 6 digits other than 000000 | Run send_ckyc_otp. Its response lists ckyc_otp and ckyc_request_id. Send the code as individual_ckyc.otp and its request ID as individual_ckyc.request_id, as in the scenario details. Confirm individual_ckyc is verified with value: null, and no proof of address is due. |
| 6 | Bank account verified Coming soon | 1234567890 with HDFC0123456 | Send it under bank_accounts.settlements_primary. Confirm verified, and the account number returned in full. |
| 7 | Bank name mismatch Coming soon | 2100000011 | Send it. Confirm verification.status: rejected with error_code: bank_name_mismatch, and bank_account due again. Send 1234567890 to clear it. |
| 8 | Category and business-model questions Coming soon | Subcategory fashion_and_lifestyle | Send the category ecommerce with this subcategory. Confirm business_model_clarifications lists bmc_question_2. Answer it with one of its options. Know more about business model questions. |
| 9 | A check that settles later Coming soon | https://curlec.com | Send it. Confirm in_progress, then verified on a fetch. Confirm Razorpay sends account.requirements.updated when the check settles. |
| 10 | Name on statements Live | A name, such as Rzp Test Store | Send it as statement_descriptor.value. |
| 11 | A value before it is due Live | A bank account before the business type | Confirm 400 step_not_due with metadata.due. |
| 12 | A read-only or unknown key Coming soon | bank_accounts.settlements_primary.verification or "bussiness_profile" | Confirm 400 invalid_request. |
| 13 | A code in the wrong format Live | 12345 | Confirm 400 invalid_format. A wrong 6-digit code returns HTTP 200 instead (#3). |
| 14 | A document ID that is not this account’s Live | A file_ ID from another account, or a deleted one | Confirm 404 not_found with the path of the document. |
| 15 | Change KYC after submission Coming soon | A new bank account while edd_pending | Submit an account without a CKYC record, as in scenario 4 on Terms and Submission. Send a bank account. Confirm 409 field_locked with metadata.status: edd_pending. |
| 16 | Change a verified value Coming soon | business_type after the PAN verifies, or a verified phone | Confirm 409 field_locked. |
| 17 | Empty body Live | {} | Confirm 400 invalid_request. |
| 18 | Retry an update Live | The same key and body | Confirm the same response, and that the value applied once. |
| 19 | Answer a reviewer Coming soon | A product in needs_clarification (settlement account 000000000003) | Follow Needs Clarification. Confirm only the flagged points can change. |
| 20 | Change the bank account after activation Coming soon | An activated account, then settlement account 000000000001 | Send the new account under bank_accounts.settlements_primary. Confirm HTTP 200, the new account checked and verified and the product still activated. Settlements move to the new account once it is verified. |
3.2 Scenario Details
The details below expand the scenarios that need more than one step:2. Verify the Phone and Email
2. Verify the Phone and Email
Before you begin: Create an account without marking the user’s contacts verified.How to test:Expected result: HTTP 200.
- Call
POST /v1/accounts/{account_id}/actions/send_phone_otpandPOST /v1/accounts/{account_id}/actions/send_email_otp. Each response’srequirementslistsphone_otporemail_otp. - Send both codes in an update:
user.is_phone_verified and is_email_verified are true, and neither code is due.Your integration should: Collect the code in your form and send it as is. Offer a resend through the action, up to 5 an hour.3. A Wrong Code
3. A Wrong Code
How to test: Send
"phone_otp": "123456".Expected result: HTTP 200, not an error, because the code was well-formed but wrong. phone_otp is still due. After 3 wrong codes, or once the code expires, send_phone_otp is due again as an action.Your integration should: Tell the sub-merchant the code did not match, and let them retry or resend.4. PAN Verified
4. PAN Verified
How to test: Send the sample request.Expected result: HTTP 200, as in the sample response. The response shows the following:
- The PAN is verified, and the authorised person’s name is
Rzp Test QA Merchant. ckyc_fetchis due as aone_of:send_ckyc_otporskip_ckyc.- The bank account is due as
settlement_bank_account. It is anall_ofofaccount_number,routing_codeandrouting_code_typeunderbank_accounts.settlements_primary. - The ₹1 UPI link is offered only after a failed check.
business_category,business_descriptionandstatement_descriptorare due.- The optional
payment_channelscomposite is listed, as aone_ofof a website or an app.
5. The CKYC Code
5. The CKYC Code
Before you begin: Complete scenario 4, so Expected result: HTTP 200.
ckyc_fetch is due.How to test:- Run
send_ckyc_otp, as in scenario 4 on Actions. Itsmetadatahas therequest_id. - Send the code as
otpand the request ID asrequest_id, both onindividual_ckyc:
business_profile.authorized_person.identity_numbers.individual_ckyc is verified with value: null. Its metadata has ckyc_mobile. The response never shows otp or request_id, because they are request-only. The proof of address comes from the CKYC record, so no Aadhaar is due.Your integration should: Send the code with the request ID the latest send_ckyc_otp returned. A resend replaces the open code and its request ID. Sending skip_ckyc instead makes proof_of_address_for_individual due.7. Bank Name Mismatch
7. Bank Name Mismatch
How to test: Send the bank account:Expected result: HTTP 200. The bank account’s
verification is rejected with error_code: bank_name_mismatch. bank_account is due again as a one_of: the account again (settlement_bank_account) or the ₹1 UPI link (create_upi_link). See the complete body on Fetch an Account.Your integration should: Show its sub-requirements as 1 choice. Send 1234567890 to clear it in test mode.11. A Value Before It Is Due
11. A Value Before It Is Due
How to test: On a new account, send a bank account before
business_type.Expected result: HTTP 400 with reason: step_not_due. metadata.due lists what is due now. Values earlier in the body are saved.Your integration should: Send only what requirements lists.15. Change KYC After Submission
15. Change KYC After Submission
Before you begin: Get an account to
edd_pending, as in scenario 4 on Terms and Submission.How to test: Send a new bank account.Expected result: HTTP 409 with reason: field_locked, field: bank_accounts.settlements_primary and metadata.status: edd_pending.Your integration should: Make the KYC details read-only in your UI while a product is under_review or edd_pending, and after activation. Keep statement_descriptor and a new settlement bank account editable after activation (#20).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 this endpoint 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. Sending values The table below lists the gaps when sending values:
After submission
The table below lists the gaps after submission: