Available in🇮🇳 India
An account is a sub-merchant on your platform. It holds the owner user, the business profile and the settlement bank account. The business profile includes the authorised person and the stakeholders. The account also lists the Razorpay products the sub-merchant is onboarding to, each with its own status and the requirements still due.
The brand name customers see on their bank statements and receipts, so they recognise the charge. Up to 255 characters.
Where the check is. Possible values:
in_progress: The check is running.deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
A stable code for the failure, such as
bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.The user who creates and operates the account and signs in to the Razorpay Dashboard, returned with
role as owner. This is the person behind the account, not the company’s owner. The email and phone belong to the user, not the account. One user can own several accounts.The user’s role on the account. The user who creates the account is its
owner. Do not send it in a request. Possible values:owneradmin
Whether the user has verified the email with a One-Time Password (OTP). Razorpay sends no OTP to a verified email.
Whether the user has verified the phone with an OTP. Razorpay sends no OTP to a verified phone.
The legal form of the business. It decides which requirements apply and cannot change after the PAN is verified. Possible values:
individual: An individual without a registered business.proprietorship: A sole proprietorship.private_limited: A private limited company.public_limited: A public limited company.section_8_company: A not-for-profit company under Section 8 of the Companies Act.llp: A limited liability partnership.partnership: A partnership firm.trust: A trust.society: A registered society.huf: A Hindu undivided family.government: A government body or undertaking.judicial_person: An artificial judicial person, such as a university or a fund.local_authority: A local authority, such as a municipal corporation.
The legal name. For an individual, it comes from the verified PAN and cannot be set. A proprietorship sends the name it trades under.
The kind of identifier, the same as its key. Possible values:
individual_pan: The PAN of a person: the authorised person, a stakeholder, an individual or a proprietor.business_pan: The PAN of the business.gstin: The Goods and Services Tax Identification Number (GSTIN). One per account: the GSTIN this account trades under. A business registered for GST in several states sends the GSTIN for this account. It sends that registration’s address asoperational_address.udyam_registration: The Udyam registration number.cin: The Corporate Identification Number (CIN).individual_ckyc: The person’s Central KYC Records Registry (CKYC) record. Itsvalueisnull. Send the code fromsend_ckyc_otpinotpand its request ID inrequest_id.
Where the check is. Possible values:
in_progress: The check is running.deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
A stable code for the failure, such as
bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.Details of the identifier. For
individual_ckyc, it holds ckyc_mobile, the mobile on the CKYC record.One KYC document, keyed by its type. Know more about the Document entity.
How the business is classified. Razorpay derives the Merchant Category Code (MCC) from the subcategory.
The subcategory of the category. Send it with
category. Razorpay derives the mcc from it. Know more about business categories and subcategories.What the business sells, such as
Clothing and accessories for men, women and children, sold online. Maximum length: 100 characters.Answers to the business-model questions, keyed by question ID. Know more about the business model questions.
The person authorised to act for the business on this account. They need not hold a share of it. For an individual or a proprietor, this is the owner. Send the owner’s personal PAN at
business_profile.authorized_person.identity_numbers.individual_pan. The business name comes from that PAN.The kind of identifier, the same as its key. Possible values:
individual_pan: The PAN of a person: the authorised person, a stakeholder, an individual or a proprietor.business_pan: The PAN of the business.gstin: The GSTIN. One per account: the GSTIN this account trades under. A business registered for GST in several states sends the GSTIN for this account. It sends that registration’s address asoperational_address.udyam_registration: The Udyam registration number.cin: The CIN.individual_ckyc: The person’s CKYC record. Itsvalueisnull. Send the code fromsend_ckyc_otpinotpand its request ID inrequest_id.
Where the check is. Possible values:
in_progress: The check is running.deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
A stable code for the failure, such as
bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.Details of the identifier. For
individual_ckyc, it holds ckyc_mobile, the mobile on the CKYC record.One KYC document, keyed by its type. Know more about the Document entity.
Which address this is, the same as its key. Possible values:
registered_address: The registered business address. For an individual, Razorpay fills it from the CKYC record or the proof of address when you do not send it.operational_address: Where the business operates for this account. One per account. With a GSTIN, it is the place of business on that GST registration.
The business’s stakeholders, the people who hold a share of it, keyed by stakeholder ID. To add a stakeholder, use any new key.
The kind of identifier, the same as its key. Possible values:
individual_pan: The PAN of a person: the authorised person, a stakeholder, an individual or a proprietor.business_pan: The PAN of the business.gstin: The GSTIN. One per account: the GSTIN this account trades under. A business registered for GST in several states sends the GSTIN for this account. It sends that registration’s address asoperational_address.udyam_registration: The Udyam registration number.cin: The CIN.individual_ckyc: The person’s CKYC record. Itsvalueisnull. Send the code fromsend_ckyc_otpinotpand its request ID inrequest_id.
Where the check is. Possible values:
in_progress: The check is running.deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
A stable code for the failure, such as
bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.Details of the identifier. For
individual_ckyc, it holds ckyc_mobile, the mobile on the CKYC record.One KYC document, keyed by its type. Know more about the Document entity.
Which address this is, the same as its key. Possible values:
registered_address: The registered business address. For an individual, Razorpay fills it from the CKYC record or the proof of address when you do not send it.operational_address: Where the business operates for this account. One per account. With a GSTIN, it is the place of business on that GST registration.
The business’s addresses, one of each
type. Razorpay merges the list by type, so an update sends only the address that changed, with its type.Which address this is. Possible values:
registered_address: The registered business address. For an individual, Razorpay fills it from the CKYC record or the proof of address when you do not send it.operational_address: Where the business operates for this account. One per account. With a GSTIN, it is the place of business on that GST registration.
Up to 15 key-value pairs for your own reference, such as your store ID, as in
notes on other Razorpay entities. Razorpay does not read these.One bank account and its verification, keyed by its purpose. The only key is
settlements_primary.The bank’s routing code: the Indian Financial System Code (IFSC) in India, as in the Payouts APIs.
The kind of
routing_code. Send it with every account number and routing code. Possible value: IFSC.Optional. It is
null unless a document is attached. No requirement asks for it, since no document type is a bank proof. Know more about the Document entity.Where the check is. Possible values:
in_progress: The check is running.deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
A stable code for the failure, such as
bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.A Razorpay product, the same as its key.
payment_gateway accepts payments on websites and apps. Possible values:payment_gatewayposbillingbusiness_bankingpayrollagent_studiooptimizer
Where the product is in onboarding. Activation needs the business’s KYC verified and the product’s own checks passed, such as the subcategory and any website sent. Razorpay checks the website again every year. Possible values:
created: The product is on the account. Nothing is submitted yet.in_progress: Information is being collected.under_review: Submitted. Razorpay is reviewing it. The KYC details are locked.needs_clarification: A reviewer asked for clarification. Only the requirements listed can change.edd_pending: Submitted. Razorpay needs enhanced due diligence first, usually a video KYC call because no CKYC record exists. The requirements holdcreate_video_kyc_link. The KYC details are locked.activated: The product is live. Live payments API keys are available.rejected: Razorpay rejected the application.status_reasonsays why. Razorpay accepts no further changes.suspended: Suspended after activation, for example when the yearly website check fails and is not resolved.status_reasonsays why.requirementslists what would resolve it.
Why the product is
rejected or suspended. It is null in every other status. Branch on code and show description.A stable code for the reason. Possible values:
category_not_allowed: Rejected: what the business sells is on Razorpay’s restricted list.clarification_not_answered: Rejected: a reviewer asked for clarification and got no answer in time.identity_not_verified: Rejected: Razorpay could not verify the owner or signatory, for example after failed video KYC calls.risk_review_failed: Rejected or suspended after Razorpay’s risk review. It never says which check failed, because Razorpay does not disclose screening outcomes.website_review_failed: Suspended: the yearly website check failed and was not resolved.
The information still due for this product, in any status, computed on every request.
[] when nothing is due. Know more about the Requirement entity.The sub-merchant’s acceptance of Razorpay’s terms of service, as Razorpay recorded it. Razorpay keeps the full record for at least 5 years after the account closes and returns only these fields.
The website check. It is
null until the check starts, then in_progress. It ends as verified or as rejected with website_unreachable.Where the check is. Possible values:
in_progress: The check is running.deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
A stable code for the failure, such as
bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.The sub-merchant’s text replies to the points a reviewer flagged in
needs_clarification. Each reply is keyed by the path of what it answers, such as bank_accounts.settlements_primary.Up to 15 key-value pairs for your own reference, such as your store ID, as in
notes on other Razorpay entities. Razorpay does not read these.