Skip to main content
GET
Available in🇮🇳 India
Use this endpoint to fetch the accounts mapped to your app, newest first. Add an account ID to the path to fetch only that account, with its requirements and the status of each element and product.
Handy Tips
  • Authenticate with the key and secret of your test pair or live pair. In the API playground, enter the test key as the username and its secret as the password. Use the live pair in live mode.
  • With an account_id, the response is that account. Without one, the response is a list.
  • Filter the list by email or phone to find the owner’s existing accounts, including ones not activated yet or only partly filled in. Let the sub-merchant continue one of them or create a new account.
  • Accounts on other platforms never appear. Neither do accounts held with Razorpay directly.
  • An email or phone with no account is not an error. The response returns count as 0.
  • Razorpay computes the requirements on every call. A GET never sends a One-Time Password (OTP), creates a link or changes state.
  • Identifiers come back in full, each with its verification. Documents come back with their url.
  • Razorpay does not return the addresses it fills from a registry or the bank’s name for the account holder. The name on the PAN comes back as business_name. Documents Razorpay fetches from a registry come back in documents.

Path Parameters

Optional. Add the account ID to the path to fetch one account: GET /v1/accounts/{account_id}.
string
The unique identifier of the account, acc_-prefixed. For example, acc_TcdGEzmfKQzEl1. Send it to fetch only this account. Without it, the endpoint returns a list of accounts.

Query Parameters

The query parameters filter the list and apply only when the path has no account_id. Every query parameter is optional. With none, the endpoint returns the accounts mapped to your app, 10 at a time.
string
Return only the accounts with this user email.
string
Return only the accounts with this user phone, +91 followed by 10 digits. Pattern: ^\+91[0-9]{10}$.
string
Return only accounts holding this product. payment_gateway accepts payments on websites and apps. Possible values:
  • payment_gateway
  • pos
  • billing
  • business_banking
  • payroll
  • agent_studio
  • optimizer
integer
Return accounts created at or after this time, as Unix time, in seconds.
integer
Return accounts created at or before this time, as Unix time, in seconds.
integer
Number of accounts to return. Range: 1-100. Default: 10.
integer
Number of accounts to skip. Minimum: 0. Default: 0.

Response Parameters

With an account_id, the response is the account. Without one, the response is a collection with these parameters:
string
Always collection.
integer
Number of accounts in this page.
array
The accounts, newest first.
Each account has the parameters below. Know more about the Account entity.
string
Unique identifier for the account, acc_-prefixed.
string
ISO 3166-1 alpha-2 country of the business, IN.
object
The brand name customers see on their bank statements and receipts, with its verification.
string
The brand name customers see on their bank statements and receipts, so they recognise the charge. Up to 255 characters.
object
The outcome of a verification check.
string
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 and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
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.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
object
Details of the statement descriptor. {} when it has none.
integer
Time at which the statement descriptor was added, as a Unix timestamp in seconds.
integer
Time at which the statement descriptor last changed, as a Unix timestamp in seconds.
boolean
Whether the owner must complete 2-factor authentication on the Razorpay Dashboard.
object
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.
string
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:
  • owner
  • admin
string
The user’s email. Maximum length: 255 characters.
string
The user’s phone: +91 followed by 10 digits.
string
The name of the person completing the onboarding. Length: 2-127 characters.
boolean
Whether the user has verified the email with an OTP. Razorpay sends no OTP to a verified email.
boolean
Whether the user has verified the phone with an OTP. Razorpay sends no OTP to a verified phone.
object
The business’s KYC identity on this account.
string
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.
string
The legal name. For an individual, it comes from the verified PAN and cannot be set. A proprietorship sends the name it trades under.
string
The date the business was established. Format: YYYY-MM-DD.
object
Government identifiers keyed by type.
object
One identifier and its verification, keyed by its type.
string
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 as operational_address.
  • udyam_registration: Udyam registration number.
  • cin: The Corporate Identification Number (CIN).
  • individual_ckyc: The person’s Central KYC Records Registry (CKYC) record. Its value is null. Send the code from send_ckyc_otp in otp and its request ID in request_id.
string
The identifier, as sent. null for individual_ckyc.
object
The outcome of a verification check.
string
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 and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
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.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
object
Details of the identifier. For individual_ckyc, it holds ckyc_mobile, the mobile on the CKYC record.
boolean
Whether the sub-merchant chose to skip this identifier, such as the CKYC record.
integer
Time at which the identifier was added, as a Unix timestamp in seconds.
integer
Time at which the identifier last changed, as a Unix timestamp in seconds.
object
The business’s KYC documents, keyed by document type. Attach each document by its id or url.
object
One KYC document, keyed by its type. Know more about the Document entity.
object
How the business is classified. Razorpay derives the Merchant Category Code (MCC) from the subcategory.
string
The business category, from the requirement’s options.
string
The subcategory of the category. Send it with category. Razorpay derives the mcc from it. Know more about business categories and subcategories.
string
The MCC. Razorpay derives it from the subcategory when you send the category and subcategory.
string
What the business sells, such as Clothing and accessories for men, women and children, sold online. Maximum length: 100 characters.
object
Answers to the business-model questions, keyed by question ID. Know more about the business model questions.
object
One business-model question and its answer.
string
The question’s ID, the same as its key.
string
The question text.
array
The allowed answers.
string
The text to show.
string
The value to send.
string
How the question is answered. Possible values:
  • single_select
  • multi_select
  • free_text
array
The answer. One value for single-select and text questions.
object
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.
string
The person’s full name.
object
The person’s identifiers keyed by type.
object
One identifier and its verification, keyed by its type.
string
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 as operational_address.
  • udyam_registration: Udyam registration number.
  • cin: The CIN.
  • individual_ckyc: The person’s CKYC record. Its value is null. Send the code from send_ckyc_otp in otp and its request ID in request_id.
string
The identifier, as sent. null for individual_ckyc.
object
The outcome of a verification check.
string
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 and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
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.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
object
Details of the identifier. For individual_ckyc, it holds ckyc_mobile, the mobile on the CKYC record.
boolean
Whether the sub-merchant chose to skip this identifier, such as the CKYC record.
integer
Time at which the identifier was added, as a Unix timestamp in seconds.
integer
Time at which the identifier last changed, as a Unix timestamp in seconds.
object
The person’s KYC documents keyed by document type.
object
One KYC document, keyed by its type. Know more about the Document entity.
object
The person’s own address. It is null unless you sent it.
string
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.
string
First line of the address.
string
Second line of the address.
string
City or district.
string
State, as an ISO 3166-2 subdivision code such as KA.
string
The 6-digit PIN code.
string
ISO 3166-1 alpha-2, for example IN.
string
The person’s date of birth. It is null unless you sent it. Format: YYYY-MM-DD.
object
Other attributes of the person, such as gender or title. {} when the person has none.
integer
Time at which the person was added, as a Unix timestamp in seconds.
integer
Time at which the person last changed, as a Unix timestamp in seconds.
object
The business’s stakeholders, the people who hold a share of it, keyed by stakeholder ID. To add a stakeholder, use any new key.
object
A stakeholder: a person who holds a share of the business.
string
The person’s full name.
object
The person’s identifiers keyed by type.
object
One identifier and its verification, keyed by its type.
string
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 as operational_address.
  • udyam_registration: Udyam registration number.
  • cin: The CIN.
  • individual_ckyc: The person’s CKYC record. Its value is null. Send the code from send_ckyc_otp in otp and its request ID in request_id.
string
The identifier, as sent. null for individual_ckyc.
object
The outcome of a verification check.
string
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 and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
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.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
object
Details of the identifier. For individual_ckyc, it holds ckyc_mobile, the mobile on the CKYC record.
boolean
Whether the sub-merchant chose to skip this identifier, such as the CKYC record.
integer
Time at which the identifier was added, as a Unix timestamp in seconds.
integer
Time at which the identifier last changed, as a Unix timestamp in seconds.
object
The person’s KYC documents keyed by document type.
object
One KYC document, keyed by its type. Know more about the Document entity.
object
The person’s own address. It is null unless you sent it.
string
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.
string
First line of the address.
string
Second line of the address.
string
City or district.
string
State, as an ISO 3166-2 subdivision code such as KA.
string
The 6-digit PIN code.
string
ISO 3166-1 alpha-2, for example IN.
string
The person’s date of birth. It is null unless you sent it. Format: YYYY-MM-DD.
object
Other attributes of the person, such as gender or title. {} when the person has none.
integer
Time at which the person was added, as a Unix timestamp in seconds.
integer
Time at which the person last changed, as a Unix timestamp in seconds.
number
Ownership as a decimal from 0 to 100. Send 25.5, not 25.5%.
array
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.
string
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.
string
First line of the address.
string
Second line of the address.
string
City or district.
string
State, as an ISO 3166-2 subdivision code such as KA.
string
The 6-digit PIN code.
string
ISO 3166-1 alpha-2, for example IN.
object
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.
string
The value under one key you chose. Maximum length: 256 characters.
object
The account’s bank accounts, keyed by purpose. settlements_primary receives settlements.
object
One bank account and its verification, keyed by its purpose. The only key is settlements_primary.
string
The purpose of the bank account, the same as its key. Possible value: settlements_primary.
string
The bank account number, 5 to 35 digits.
string
The bank’s routing code: the Indian Financial System Code (IFSC) in India, as in the Payouts APIs.
string
The kind of routing_code. Send it with every account number and routing code. Possible value: IFSC.
object
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.
object
The outcome of a verification check.
string
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 and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
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.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
object
The products the account holds, keyed by product type, such as payment_gateway.
object
One product, keyed by its type, with its status and the requirements still due.
string
A Razorpay product, the same as its key. payment_gateway accepts payments on websites and apps. Possible values:
  • payment_gateway
  • pos
  • billing
  • business_banking
  • payroll
  • agent_studio
  • optimizer
string
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 hold create_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_reason says why. Razorpay accepts no further changes.
  • suspended: Suspended after activation, for example when the yearly website check fails and is not resolved. status_reason says why. requirements lists what would resolve it.
object
Why the product is rejected or suspended. It is null in every other status. Branch on code and show description.
string
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’s clarification was not answered in time.
  • identity_not_verified: Rejected: the owner or signatory could not be verified, 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.
string
A sentence to show the sub-merchant. The wording can change.
integer
Time at which the product was requested, as a Unix timestamp in seconds.
integer
Time at which the product last changed, as a Unix timestamp in seconds.
array
The information still due for this product, in any status, computed on every request. [] when nothing is due. Know more about the Requirement entity.
object
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. Razorpay returns only these fields.
string
The IP address the sub-merchant accepted from.
string
The device fingerprint of the sub-merchant’s device.
object
Details of the acceptance. {} when the acceptance has none.
integer
Time at which the sub-merchant accepted, as a Unix timestamp in seconds.
object
For payment_gateway: the channels the business accepts payments on.
object
The business’s website.
string
The live website, on https. Razorpay checks liveness, content and MCC from it.
array
Other websites of the business.
object
The website check. It is null until the check starts, then in_progress. It ends as verified or as rejected with website_unreachable.
string
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 and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
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.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
object
The Android app.
string
The Play Store link.
object
The iOS app.
string
The App Store link.
object
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.
string
One reply, under the path of what it answers.
object
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.
string
The value of one note, under a key you chose. Maximum length: 256 characters.
integer
Time at which the account was created, as a Unix timestamp in seconds.
integer
Time at which the account last changed, as a Unix timestamp in seconds.

Errors

Code: 400Reason: invalid_formatA query parameter does not match its format:
  • email is not an email.
  • phone is not +91 and 10 digits.
  • from or to is not a Unix time.
  • count is outside 1-100.
  • skip is negative.
An email or phone with no account is not an error. It returns count: 0.Solution: Correct the value named in error.field and send it again. metadata.pattern shows the expected format. metadata.minimum and metadata.maximum show the range.
Code: 400Reason: invalid_optionproduct is not a product.Solution: Send one of the allowed values. metadata.allowed_values lists them when the list is short.
Code: 400Reason: invalid_requestfrom is after to.Solution: Send a from that is at or before to.
Code: 401Reason: invalid_credentialsThe Authorization header is missing or is not Basic. Other causes are a key that is not a partner key or a wrong secret. A secret also stops working when it is revoked or its rotation window ends.Solution: Send your partner key and secret as HTTP Basic credentials. Check that the secret is current for the key.
Code: 403Reason: onboarding_not_enabledYour app does not have access to the Onboarding APIs in this mode. Razorpay may also have turned off your app’s access.Solution: Contact Razorpay to get access to the Onboarding APIs for your app in this mode.
Code: 403Reason: ip_not_allowedThe request came from an IP address outside your app’s allowlist for its mode. Test mode checks the allowlist once it has an entry.Solution: Send requests from an IP range on your app’s allowlist for this mode. To use another range, add it to the allowlist on the Partner Dashboard.
Code: 403Reason: consent_withdrawnThrough Razorpay, the sub-merchant withdrew your permission to act on the account. Calls on this account never succeed again for your platform.Solution: Stop calling this account and update your records.
Code: 404Reason: not_foundNo account with this ID is mapped to your app in this mode. The account does not exist, belongs to another platform or belongs to a direct Razorpay merchant. It can also be a test account called in live mode.Solution: Check the ID in error.field. Use the ID of an account mapped to your app, in the same mode as your key.
Code: 429Reason: rate_limitedYour app sent more requests than its rate limit allows.Solution: Wait for the time in the Retry-After header, then retry.
Code: 500Reason: internal_errorSomething went wrong inside Razorpay.Solution: Retry the request.
Last modified on November 18, 2026