API Test Keys

Stakeholder Entity

The Stakeholder entity has the following parameters.

Is this page helpful?

Entity

1{
2  "entity":"stakeholder",
3  "relationship":{
4    "executive":true
5  },
6  "phone":{
7    "primary":"+60123456789",
8    "secondary":"+60123456789"
9  },
10  "notes":[
11    
12  ],
13  "kyc":{
14  },
15  "id":"sth_GLGgm8fFCKc92m",
16  "name":" Nur Aisyah",
17  "email":"nur.aisyah@example.com",
18  "percentage_ownership":null,
19  "addresses":{
20    "residential":{
21      "street": "506 bacca street",
22      "city": "Malacca",
23      "state": "Malacca",
24      "postal_code": "43200",
25      "country": "MY"
26    }
27  }
28}

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. 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. director : boolean Determines if stakeholder is a director of the account's legal entity.

true: Stakeholder is a director.
false (default): Stakeholder is not a director. executive : boolean Determines if the stakeholder is an executive of the account's legal entity.
true: Stakeholder is an executive.
false (false): Stakeholder is not an executive.

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.

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”.

Stakeholder Entity

The Stakeholder entity has the following parameters.

Is this page helpful?

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. 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. director : boolean Determines if stakeholder is a director of the account's legal entity.

true: Stakeholder is a director.
false (default): Stakeholder is not a director. executive : boolean Determines if the stakeholder is an executive of the account's legal entity.
true: Stakeholder is an executive.
false (false): Stakeholder is not an executive.

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.

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”.

Entity

1{
2  "entity":"stakeholder",
3  "relationship":{
4    "executive":true
5  },
6  "phone":{
7    "primary":"+60123456789",
8    "secondary":"+60123456789"
9  },
10  "notes":[
11    
12  ],
13  "kyc":{
14  },
15  "id":"sth_GLGgm8fFCKc92m",
16  "name":" Nur Aisyah",
17  "email":"nur.aisyah@example.com",
18  "percentage_ownership":null,
19  "addresses":{
20    "residential":{
21      "street": "506 bacca street",
22      "city": "Malacca",
23      "state": "Malacca",
24      "postal_code": "43200",
25      "country": "MY"
26    }
27  }
28}