Available in🇮🇳 India
When a risk review needs answers from the sub-merchant, Razorpay raises a requirement on the account’s payment_gateway product, at products.payment_gateway.requirements. You read it with the GET account API and answer it by uploading documents and updating the account.
Raising a requirement does not change the product’s status. Only an action changes what the sub-merchant can do.
The Journey
1
Razorpay Raises a Requirement
account.product.payment_gateway.requirement.needs_clarification arrives with the requirement, in needs_clarification. Razorpay may also take an action that points to it through status_reason.requirement_id. Know more about clarifications webhooks.2
Fetch the Account
Fetch the account. The requirement sits at
products.payment_gateway.requirements. GET /v1/accounts/{id}. To fetch one requirement by its id: GET /v1/accounts/{id}/products/payment_gateway/requirements/{requirement_id}3
Upload Each Document
Upload one file per call, with the requirement’s
requirement_code as document_type. Keep each returned id. POST /v1/accounts/{id}/documents/{document_type}4
Send Every Response in One Update
Answer the requirements: mirror the requirement by
id and send a requirement_response with text or documents on each input requirement. PATCH /v1/accounts/{id}. The requirement moves to under_review.5
Razorpay Reviews
Razorpay resolves the requirement, with
account.product.payment_gateway.requirement.resolved, or asks again, with account.product.payment_gateway.requirement.needs_clarification and the requirement back in needs_clarification. Send the new responses.The Requirement
A clarification is one requirement with its sub-requirements:- The top requirement: A
compositerequirement for the review, with thedue_atdeadline. Itsid, such asreq_UYTBV02QSYTRVK, is therequirement_idthat an action points to. - Its sub-requirements: Listed in
sub_requirements. Each is aninput: a question (value_type: text) or a document request (value_type: document) that you answer.
Statuses
A requirement has 4 statuses:
The diagram below shows who moves a requirement between statuses:
The table below lists each move and its webhook. Each move fires the event named after the status it moves to:
Your only move is to submit. Every other move is Razorpay’s. A resolved requirement no longer appears in
requirements when you fetch the account.
Deadline
Ifdue_at passes while responses are still due, the requirement moves to overdue and Razorpay sends account.product.payment_gateway.requirement.overdue. Razorpay reviews the account and may disable payments, put settlement on hold or suspend the product, each with its own event. You can still respond: your submit moves the requirement to under_review.
Next Steps
- Clarifications API: fetch the requirements, upload documents and answer.
- Clarifications webhooks: the 4 requirement events.
- Actions: how an action points to a requirement.