Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Linked Account Onboarding

Stakeholder

Update Stakeholder

API Test Keys

Update a Stakeholder Account

PATCH
/v2/accounts/:account_id/stakeholders/:stakeholder_id

Click to copy

Use this endpoint to update a stakeholder account.

Is this page helpful?

Curl

change language

change language

1
curl -X PATCH 'https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders/sth_GOQ4Eftlz62TSL' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
     -H "Content-type: application/json" \
4
     -d '{
5
   "addresses":{
6
      "residential":{
7
         "street":"507, Koramangala 1st block",
8
         "city":"Bangalore",
9
         "state":"Karnataka",
10
         "postal_code":"560035",
11
         "country":"IN"
12
      }
13
   },
14
   "kyc":{
15
      "pan":"AVOPBXXXXX"
16
   }
17
}'

Success

Failure

1
{
2
  "entity": "stakeholder",
3
  "relationship": {
4
    "executive": true
5
  },
6
  "phone": {
7
    "primary": "9000090000",
8
    "secondary": "9000090000"
9
  },
10
  "notes": {
11
    "random_key_by_partner": "random_value"
12
  },
13
  "kyc": {
14
    "pan": "AVOPB1111K"
15
  },
16
  "id": "sth_GLGgm8fFCKc92m",
17
  "name": "Gaurav Kumar",
18
  "email": "gaurav.kumar@example.com",
19
  "percentage_ownership": 10,
20
  "addresses": {
21
    "residential": {
22
      "street": "506, Koramangala 1st block",
23
      "city": "Bengaluru",
24
      "state": "Karnataka",
25
      "postal_code": "560034",
26
      "country": "IN"
27
    }
28
  }
29
}
Path Parameters
account_id
string

The unique identifier of the account generated by Razorpay. For example, acc_GLGeLkU2JUeyDZ. This id is used to fetch or update a stakeholder.

stakeholder_id
string

The unique of the stakeholder account created. For example, sth_GOQ4Eftlz62TSL.

Request Parameters
name

*

string

The stakeholder's name as per the PAN card. The maximum length is 255 characters.

email

*

string

The stakeholder's email address. The maximum length is:

  • local part (before @): 64 characters.
  • domain part (after @): 68 characters.
    The total character length supported is 132.

percentage_ownership
float

The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, 87.55. The maximum length is 100 characters.

relationship
boolean

The stakeholder's relationship with the account’s business. The default value is false.

  • director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
  • executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone
object

The stakeholder's phone number.

Show child parameters (2)

addresses
object

Details of stakeholder's address.

Show child parameters (1)

kyc
object

The type of document required to establish the stakeholder's identity.

Show child parameters (1)

notes
object

Contains user-defined fields stored for reference purposes. Maximum 15 key-value pairs, 512 characters (maximum) each.

Response Parameters
id
string

The unique identifier of a stakeholder generated by Razorpay, used to fetch or update a stakeholder. For example, sth_GLGgm8fFCKc92m. Maximum length supported is 18 characters.

entity
string

Here it is stakeholder.

percentage_ownership
float

The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, 87.55. The maximum length is 100 characters.

name
string

The stakeholder's name as per the PAN card. The maximum length is 255 characters.

email
string

The stakeholder's email address. The maximum length is:

  • local part (before @): 64 characters.
  • domain part (after @): 68 characters.

relationship
object

The stakeholder's relationship with the account’s business. The default value is false.

  • director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
  • executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone
object

The stakeholder's phone number.

Show child parameters (2)

addresses
object

Details of stakeholder's address.

Show child parameters (1)

kyc
object

The type of document required to establish the stakeholder's identity.

Show child parameters (1)

notes
object

Contains user-defined fields stored by the partner for reference purposes. It can hold a maximum of 15 key-value pairs, 512 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Errors

Linked account does not exist.

Error Status: 400

This error occurs when the requester is not the parent of the child account, or the child account does not exist.

Solution

The id provided does not exist.

Error Status: 400

This error occurs when the stakeholder does not belong to the account provided.

Solution

Merchant activation form has been locked for editing by admin.

Error Status: 400

This error occurs when the submitted extra fields are under the review stage.

Solution

Update a Stakeholder Account

PATCH
/v2/accounts/:account_id/stakeholders/:stakeholder_id

Click to copy

Use this endpoint to update a stakeholder account.

Is this page helpful?

Path Parameters
account_id
string

The unique identifier of the account generated by Razorpay. For example, acc_GLGeLkU2JUeyDZ. This id is used to fetch or update a stakeholder.

stakeholder_id
string

The unique of the stakeholder account created. For example, sth_GOQ4Eftlz62TSL.

Request Parameters
name

*

string

The stakeholder's name as per the PAN card. The maximum length is 255 characters.

email

*

string

The stakeholder's email address. The maximum length is:

  • local part (before @): 64 characters.
  • domain part (after @): 68 characters.
    The total character length supported is 132.

percentage_ownership
float

The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, 87.55. The maximum length is 100 characters.

relationship
boolean

The stakeholder's relationship with the account’s business. The default value is false.

  • director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
  • executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone
object

The stakeholder's phone number.

Show child parameters (2)

addresses
object

Details of stakeholder's address.

Show child parameters (1)

kyc
object

The type of document required to establish the stakeholder's identity.

Show child parameters (1)

notes
object

Contains user-defined fields stored for reference purposes. Maximum 15 key-value pairs, 512 characters (maximum) each.

Response Parameters
id
string

The unique identifier of a stakeholder generated by Razorpay, used to fetch or update a stakeholder. For example, sth_GLGgm8fFCKc92m. Maximum length supported is 18 characters.

entity
string

Here it is stakeholder.

percentage_ownership
float

The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, 87.55. The maximum length is 100 characters.

name
string

The stakeholder's name as per the PAN card. The maximum length is 255 characters.

email
string

The stakeholder's email address. The maximum length is:

  • local part (before @): 64 characters.
  • domain part (after @): 68 characters.

relationship
object

The stakeholder's relationship with the account’s business. The default value is false.

  • director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
  • executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone
object

The stakeholder's phone number.

Show child parameters (2)

addresses
object

Details of stakeholder's address.

Show child parameters (1)

kyc
object

The type of document required to establish the stakeholder's identity.

Show child parameters (1)

notes
object

Contains user-defined fields stored by the partner for reference purposes. It can hold a maximum of 15 key-value pairs, 512 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Errors

Linked account does not exist.

Error Status: 400

This error occurs when the requester is not the parent of the child account, or the child account does not exist.

Solution

The id provided does not exist.

Error Status: 400

This error occurs when the stakeholder does not belong to the account provided.

Solution

Merchant activation form has been locked for editing by admin.

Error Status: 400

This error occurs when the submitted extra fields are under the review stage.

Solution

Curl

change language

change language

1
curl -X PATCH 'https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders/sth_GOQ4Eftlz62TSL' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
     -H "Content-type: application/json" \
4
     -d '{
5
   "addresses":{
6
      "residential":{
7
         "street":"507, Koramangala 1st block",
8
         "city":"Bangalore",
9
         "state":"Karnataka",
10
         "postal_code":"560035",
11
         "country":"IN"
12
      }
13
   },
14
   "kyc":{
15
      "pan":"AVOPBXXXXX"
16
   }
17
}'

Success

Failure

1
{
2
  "entity": "stakeholder",
3
  "relationship": {
4
    "executive": true
5
  },
6
  "phone": {
7
    "primary": "9000090000",
8
    "secondary": "9000090000"
9
  },
10
  "notes": {
11
    "random_key_by_partner": "random_value"
12
  },
13
  "kyc": {
14
    "pan": "AVOPB1111K"
15
  },
16
  "id": "sth_GLGgm8fFCKc92m",
17
  "name": "Gaurav Kumar",
18
  "email": "gaurav.kumar@example.com",
19
  "percentage_ownership": 10,
20
  "addresses": {
21
    "residential": {
22
      "street": "506, Koramangala 1st block",
23
      "city": "Bengaluru",
24
      "state": "Karnataka",
25
      "postal_code": "560034",
26
      "country": "IN"
27
    }
28
  }
29
}