Account
Create an Account
Onboard sub-merchants by creating an account using Razorpay Partners APIs.
POST
Use this endpoint to create an account.
Request Parameters
string
required
The sub-merchant’s business email address.
integer
required
The sub-merchant’s business phone number, without the country code. The minimum length is 8 characters and the maximum length is 15. For example,
9876543210.string
required
The name of the sub-merchant’s business. For example,
Acme Corp. The minimum length is 4 characters and the maximum length is 200.string
The sub-merchant billing label as it appears on the Dashboard. The minimum length is 1 character and the maximum length is 255.
string
required
The type of business operated by the sub-merchant. Possible values: Business Types.
string
Partner’s external account reference id. The minimum length is 1 character and the maximum length is 512.
object
The business details of the sub-merchant’s account.
string
required
The business category of the sub-merchant. Possible values: List of Business Categories.
string
required
The business sub-category of the sub-merchant. Possible values: List of Business Sub-Categories.
string
This parameter has been deprecated. Pass the description using the
business_model parameter.string
The business description. The character limit between 1-255 characters.
object
Details of sub-merchant’s address.
object
Details of the sub-merchant’s operational address.
string
Address, line 1. The maximum length is 100 characters.
string
Address, line 2. The maximum length is 100 characters.
string
The city. The maximum length is 100 characters.
string
The state. The minimum length is 2 and the maximum length is 32.
integer
The postal code. This should be exactly 6 characters.
string
The country. The minimum length is 2 and the maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either
IN or india. List of supported Countries.object
required
Details of the sub-merchant’s registered address.
string
Address, line 1. The maximum length is 100 characters.
string
Address, line 2. The maximum length is 100 characters.
string
The city. The maximum length is 100 characters.
string
The state. The minimum length is 2 and the maximum length is 32.
integer
The postal code. This should be exactly 6 characters.
string
The country. The minimum length is 2 and the maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either
IN or india. List of supported Countries.object
The legal details about the sub-merchant’s business.
string
Valid PAN number details of the sub-merchant’s business.
- This is a 10-digit alphanumeric code. For example,
AVOJB1111K. - The 4th digit should be either of ‘C’, ‘H’, ‘F’, ‘A’, ‘T’, ‘B’, ‘J’, ‘G’, ‘L’.
- The regex for Company PAN is
/^[a-zA-z]{5}\d{4}[a-zA-Z]{1}$/.
string
Valid GSTIN number details of the sub-merchant.
- This is a 15-digit PAN-based unique identification number.
- The Regex for GSTIN is
/^[0123][0-9][a-z]{5}[0-9]{4}[a-z][0-9][a-z0-9][a-z0-9]$/gi
string
CIN is for Private Limited and Public Limited, whereas LLPIN is for LLP business type.
- This is a 21-digit alpha-numeric number.
- The Regex for CIN is
/^([a-z]{3}-\d{4}|[ul]\d{5}[a-z]{2}\d{4}[a-z]{3}\d{6})$/i.
object
The branding details of the sub-merchant’s business.
string
The color code of sub-merchant’s business brand. This is a 6-character hex code (Regex: [a-fA-F0-9]{6}).
object
Contains user-defined fields stored by the partner for reference purposes.
string
required
The name of the contact. The minimum length is 4 and the maximum length is 255 characters.
object
Options available for contact support.
object
The type of contact support.
string
The email id of chargeback POC. The maximum length is:
- local part (before @): 64 characters.
- domain part (after @): 68 characters.
The total character length supported is 132.
string
The phone number of chargeback POC. The minimum length is 8 and the maximum length is 10 characters.
string
The URL of chargeback policy.
object
The type of contact support.
string
The email id of refund POC. The maximum length is:
- local part (before @): 64 characters.
- domain part (after @): 68 characters.
The total character length supported is 132.
string
The phone number of refund POC. The minimum length is 8 and the maximum length is 10 characters.
string
The URL of refund policy.
object
The type of contact support.
string
The email id of support POC. The maximum length is:
- local part (before @): 64 characters.
- domain part (after @): 68 characters.
The total character length supported is 132.
string
The phone number of support POC. The minimum length is 8 and the maximum length is 10 characters.
string
The URL of support policy.
object
The website/app details of the sub-merchant’s business.
array
The websites for the sub-merchant’s business. A minimum of 1 website is required.
array
Android app details
string
The link of the Android app. Regex is (protocol://
protocol-both http/https allowed.
razorpay.com:port/resource path?querystring#fragementid) protocol-both http/https allowed.
string
The name of the Android app.
array
iOS app details
string
The link of the iOS app. Regex is (protocol://
protocol-both http/https allowed.
razorpay.com:port/resource path?querystring#fragementid) protocol-both http/https allowed.
string
The name of the iOS app.
Response Parameters
string
The unique identifier of a sub-merchant account generated by Razorpay. The maximum length is 18 characters. For example,
acc_GLGeLkU2JUeyDZ.string
The account type. Possible value is
standard.string
The status of the account. Possible values:
created: Account status when the merchant account is created.activated: Account status when the merchant KYC is approved.needs_clarification: Account status when the merchant is asked to provide clarifications related to the KYC details submitted.under_review: Account status when the merchant submits all the KYC requirements.suspended: Account status when the merchant account is identified as potentially fraudulent and is suspended.rejected: Account status when the KYC details submitted by the merchant are rejected during manual review.
string
The sub-merchant’s business email address.
integer
The sub-merchant’s business phone number. The minimum length is 8 characters and the maximum length is 15.
string
The name of the sub-merchant’s business. For example,
Acme Corp. The minimum length is 4 characters and the maximum length is 200.string
The sub-merchant billing label as it appears on the Dashboard. The minimum length is 1 character and the maximum length is 255. This parameter might be required to complete the KYC process. However, it is optional for this API.
string
The type of business operated by the sub-merchant. Possible values: Business Types.
string
Partner’s external account reference id. The minimum length is 1 character and the maximum length is 512.
object
The business details of the sub-merchant’s account.
string
The business category of the sub-merchant. Possible values: Business Category
string
The business sub-category of the sub-merchant. Possible values: Business Sub-Category
string
This parameter has been deprecated. Pass the description using the
business_model parameter.string
The business description. The minimum length is 1 character and the maximum length is 255.
object
Details of sub-merchant’s address.
object
Details of the sub-merchant’s operational address. This parameter might be required to complete the KYC process. However, it is optional for this API.
string
Address, line 1. The maximum length is 100 characters.
string
Address, line 2. The maximum length is 100 characters.
string
The city. The maximum length is 100 characters.
string
The state. The minimum length is 2 and the maximum length is 100.
integer
The postal code. This should be exactly 6 characters.
string
The country. The minimum length is 2 and the maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either
IN or india. List of supported Countries.object
Details of the sub-merchant’s registered address.
string
Address, line 1. The maximum length is 100 characters.
string
Address, line 2. The maximum length is 100 characters.
string
The city. The maximum length is 100 characters.
string
The state. The minimum length is 2 and the maximum length is 100.
integer
The postal code. This should be exactly 6 characters.
string
The country. The minimum length is 2 and the maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either
IN or india. List of supported Countries.object
The legal details about the sub-merchant’s business.
string
Valid PAN number details of the sub-merchant’s business.
- This is a 10-digit alphanumeric code. For example,
AVOJB1111K. - The 4th digit should be either of ‘C’, ‘H’, ‘F’, ‘A’, ‘T’, ‘B’, ‘J’, ‘G’, ‘L’.
- The regex for Company PAN is
/^[a-zA-z]{5}\d{4}[a-zA-Z]{1}$/.
This parameter might be required to complete the KYC process. However, it is optional for this API. Business types like proprietorship and individual (not_yet_registered), do not require Business PAN.
string
Valid GSTIN number details of the sub-merchant.
- This is a 15-digit PAN-based unique identification number.
- The Regex to validate GSTIN is
/^[0123][0-9][a-z]{5}[0-9]{4}[a-z][0-9][a-z0-9][a-z0-9]$/gi.
string
CIN is for Private Limited and Public Limited, whereas LLPIN is for LLP business type.
- This is a 21-digit alpha-numeric number.
- The Regex to validate CIN is
/^([a-z]{3}-\d{4}|[ul]\d{5}[a-z]{2}\d{4}[a-z]{3}\d{6})$/i.
object
The branding details of the sub-merchant’s business.
string
The color code of sub-merchant’s business brand. This is a 6-character hex code (Regex: [a-fA-F0-9]{6}).
object
Contains user-defined fields stored by the partner for reference purposes.
string
The name of the contact. The minimum length is 4 and the maximum length is 255 characters.
object
Options available for contact support.
object
The type of contact support.
string
The email id of chargeback POC. The maximum length is:
- local part (before @): 64 characters.
- domain part (after @): 68 characters.
The total character length supported is 132.
integer
The phone number of chargeback POC. The maximum length is 10 characters.
string
The URL of chargeback policy. Regex is (protocol://
protocol-both http/https allowed. Only domain name is mandatory.
razorpay.com:port/resource path?querystring#fragementid)protocol-both http/https allowed. Only domain name is mandatory.
object
The type of contact support.
string
The email id of refund POC. The maximum length is:
- local part (before @): 64 characters.
- domain part (after @): 68 characters.
The total character length supported is 132.
integer
The phone number of refund POC. The maximum length is 10 characters.
string
The URL of refund policy. Regex is (protocol://
protocol-both http/https allowed.
razorpay.com:port/resource path?querystring#fragementid) protocol-both http/https allowed.
array
The type of contact support.
string
The email id of support POC. The maximum length is:
- local part (before @): 64 characters.
- domain part (after @): 68 characters.
The total character length supported is 132.
integer
The phone number of support POC. The maximum length is 10 characters.
string
The URL of support policy. Regex is (protocol://
protocol-both http/https allowed.
razorpay.com:port/resource path?querystring#fragementid) protocol-both http/https allowed.
object
The app details of the sub-merchant’s business
array
The website/app for the sub-merchant’s business. A minimum of 1 website is required.
array
Android app details
string
The link of the Android app. Regex is (protocol://
protocol-both http/https allowed.
razorpay.com:port/resource path?querystring#fragementid) protocol-both http/https allowed.
string
The name of the Android app.
array
iOS app details
string
The link of the iOS app. Regex is (protocol://
protocol-both http/https allowed.
razorpay.com:port/resource path?querystring#fragementid) protocol-both http/https allowed.
string
The name of the iOS app.
integer
Unix timestamp that indicates when the merchant account was activated. This parameter has
null value till the account is activated.boolean
Indicates the payments acceptance status of the merchant account. Possible values:
true: Merchant can start accepting customer payments.false: Merchant cannot accept customer payments.
boolean
Indicates the settlements status of the merchant account. Possible values:
true: Settlement are on hold. Funds are not transferred to the merchant account.false: Settlements can be transferred to the merchant account.