Update an Account

PATCH

/v2/accounts/:account_id

Click to copy

Use this endpoint to update the details of a sub-merchant account.

The information you can update using the Update an Account API differs based on the product activation status.

Activation Status	Update Permitted
`requested`	You can update the details for all the fields.
`needs_clarification`	The fields you can update depend on the `reason_code` mentioned in the `requirements` object in the Request a Product Activation API : document_missing or field_missing: You can update all the fields. needs_clarification: You can update only the specific field for which Razorpay is seeking clarification for.
`under_review`	You cannot update any fields.
`activated`	You cannot use this API to update any fields as your account is already active.

Watch Out!

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Know about the

various error responses

for this API.

Is this page helpful?

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2-H "Content-Type: application/json" \
3-X PATCH https://api.razorpay.com/v2/accounts/acc_GP4lfNA0iIMn5B \
4-d '{
5	"customer_facing_business_name": "ABCD Ltd"
6}'

Success

1{
2  "id": "acc_GP4lfNA0iIMn5B",
3  "type": "standard",
4  "status": "created",
5  "email": "gauri@example.org",
6  "profile": {
7    "category": "healthcare",
8    "subcategory": "clinic",
9    "addresses": {
10      "registered": {
11        "street1": "507, Koramangala 1st block",
12        "street2": "MG Road-1",
13        "city": "Bengalore",
14        "state": "KARNATAKA",
15        "postal_code": "560034",
16        "country": "IN"
17      }
18    }
19  },
20  "notes": [],
21  "created_at": 1610603081,
22  "phone": "9000090000",
23  "reference_id": "randomId",
24  "business_type": "partnership",
25  "legal_business_name": "Acme Corp",
26  "customer_facing_business_name": "ABCD Ltd"
27}

Path Parameters

account_id

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_GP4lfNA0iIMn5B.

Response Parameters

id

string

The unique identifier of a sub-merchant account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.

type

string

The account type. Possible value is standard.

status

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.

email

string

The sub-merchant's business email address.

phone

integer

The sub-merchant's business phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name

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.

customer_facing_business_name

string

The sub-merchant billing label as it appears on the Razorpay 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.

business_type

string

The type of business operated by the sub-merchant. Possible values:

Business Types

reference_id

string

Partner's external account reference id. The minimum length is 1 character and the maximum length is 512.

profile

object

The business details of the sub-merchant's account.

Show child parameters (5)

legal_info

object

The legal details about the sub-merchant's business.

Show child parameters (3)

brand

object

The branding details of the sub-merchant's business.

Show child parameters (1)

notes

object

Contains user-defined fields stored by the partner for reference purposes.

contact_name

string

The name of the contact. The minimum length is 4 and the maximum length is 255 characters.

contact_info

object

Options available for contact support.

Show child parameters (3)

apps

object

The app details of the sub-merchant's business

Show child parameters (3)

activated_at

integer

Unix timestamp that indicates when the merchant account was activated. This parameter has null value till the account is activated.

live

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.

hold_funds

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.

Update an Account

PATCH

/v2/accounts/:account_id

Click to copy

Use this endpoint to update the details of a sub-merchant account.

The information you can update using the Update an Account API differs based on the product activation status.

Activation Status	Update Permitted
`requested`	You can update the details for all the fields.
`needs_clarification`	The fields you can update depend on the `reason_code` mentioned in the `requirements` object in the Request a Product Activation API : document_missing or field_missing: You can update all the fields. needs_clarification: You can update only the specific field for which Razorpay is seeking clarification for.
`under_review`	You cannot update any fields.
`activated`	You cannot use this API to update any fields as your account is already active.

Watch Out!

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Know about the

various error responses

for this API.

Is this page helpful?

Path Parameters

account_id

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_GP4lfNA0iIMn5B.

Response Parameters

id

string

The unique identifier of a sub-merchant account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.

type

string

The account type. Possible value is standard.

status

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.

email

string

The sub-merchant's business email address.

phone

integer

The sub-merchant's business phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name

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.

customer_facing_business_name

string

business_type

string

The type of business operated by the sub-merchant. Possible values:

Business Types

reference_id

string

Partner's external account reference id. The minimum length is 1 character and the maximum length is 512.

profile

object

The business details of the sub-merchant's account.

Show child parameters (5)

legal_info

object

The legal details about the sub-merchant's business.

Show child parameters (3)

brand

object

The branding details of the sub-merchant's business.

Show child parameters (1)

notes

object

Contains user-defined fields stored by the partner for reference purposes.

contact_name

string

The name of the contact. The minimum length is 4 and the maximum length is 255 characters.

contact_info

object

Options available for contact support.

Show child parameters (3)

apps

object

The app details of the sub-merchant's business

Show child parameters (3)

activated_at

integer

Unix timestamp that indicates when the merchant account was activated. This parameter has null value till the account is activated.

live

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.

hold_funds

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.

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2-H "Content-Type: application/json" \
3-X PATCH https://api.razorpay.com/v2/accounts/acc_GP4lfNA0iIMn5B \
4-d '{
5	"customer_facing_business_name": "ABCD Ltd"
6}'

Success

1{
2  "id": "acc_GP4lfNA0iIMn5B",
3  "type": "standard",
4  "status": "created",
5  "email": "gauri@example.org",
6  "profile": {
7    "category": "healthcare",
8    "subcategory": "clinic",
9    "addresses": {
10      "registered": {
11        "street1": "507, Koramangala 1st block",
12        "street2": "MG Road-1",
13        "city": "Bengalore",
14        "state": "KARNATAKA",
15        "postal_code": "560034",
16        "country": "IN"
17      }
18    }
19  },
20  "notes": [],
21  "created_at": 1610603081,
22  "phone": "9000090000",
23  "reference_id": "randomId",
24  "business_type": "partnership",
25  "legal_business_name": "Acme Corp",
26  "customer_facing_business_name": "ABCD Ltd"
27}