Docs Logo

Linked Accounts

Create a Linked Account

Update a Linked Account

Fetch a Linked Account With ID

Create a Stakeholder Account

Update a Stakeholder Account

Request a Product Configuration

Update a Product Configuration

Fetch a Product Configuration

Docs Logo

API Test keys

Api

Payments

Route

Linked Account Onboarding

Create Stakeholder

API Test keys

Api

Payments

Route

Linked Account Onboarding

Create Stakeholder

Create a Stakeholder Account

POST
/v1/accounts/:account_id/stakeholders

Click to copy

Use this endpoint to create a stakeholder account.

Is this page helpful?

Curl

1
curl -X POST 'https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
     -H "Content-type: application/json" \
4
     -d '{
5
   "name":"Gaurav Kumar",
6
   "email": "gaurav.kumar234@example.com",
7
   "addresses":{
8
      "residential":{
9
         "street":"506, Koramangala 1st block",
10
         "city":"Bengaluru",
11
         "state":"Karnataka",
12
         "postal_code":"560034",
13
         "country":"IN"
14
      }
15
   },
16
   "kyc":{
17
      "pan":"AVOPB1111K"
18
   },
19
   "notes":{
20
      "random_key":"random_value"
21
   }
22
}'

Success

Failure

1
{
2
   "entity":"stakeholder",
3
   "relationship":{
4
      "executive":true
5
   },
6
   "phone":{
7
      "primary":9000090000,
8
      "secondary":999999991
9
   },
10
   "notes":[
11
      
12
   ],
13
   "kyc":{
14
      "pan":"CZCPG5228F"
15
   },
16
   "id":"sth_GLGgm8fFCKc92m",
17
   "name":"Gaurav Kumar",
18
   "email":"gaurav.kumar234@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.

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

Stakeholders cannot be more than one for Route product.

Error Status: 400

This error occurs when you try to create more than one stakeholder for Linked Accounts.

Solution

Create a Stakeholder Account

POST
/v1/accounts/:account_id/stakeholders

Click to copy

Use this endpoint to create 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.

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

Stakeholders cannot be more than one for Route product.

Error Status: 400

This error occurs when you try to create more than one stakeholder for Linked Accounts.

Solution

Curl

1
curl -X POST 'https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
     -H "Content-type: application/json" \
4
     -d '{
5
   "name":"Gaurav Kumar",
6
   "email": "gaurav.kumar234@example.com",
7
   "addresses":{
8
      "residential":{
9
         "street":"506, Koramangala 1st block",
10
         "city":"Bengaluru",
11
         "state":"Karnataka",
12
         "postal_code":"560034",
13
         "country":"IN"
14
      }
15
   },
16
   "kyc":{
17
      "pan":"AVOPB1111K"
18
   },
19
   "notes":{
20
      "random_key":"random_value"
21
   }
22
}'

Success

Failure

1
{
2
   "entity":"stakeholder",
3
   "relationship":{
4
      "executive":true
5
   },
6
   "phone":{
7
      "primary":9000090000,
8
      "secondary":999999991
9
   },
10
   "notes":[
11
      
12
   ],
13
   "kyc":{
14
      "pan":"CZCPG5228F"
15
   },
16
   "id":"sth_GLGgm8fFCKc92m",
17
   "name":"Gaurav Kumar",
18
   "email":"gaurav.kumar234@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
}