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

Update Linked Accounts

API Test keys

Api

Payments

Route

Linked Account Onboarding

Update Linked Accounts

Update a Linked Account

PATCH
/v1/accounts/:account_id

Click to copy

Use this endpoint to update a Linked Account details.

You can update all other fields except business_type and email on the created Linked Account.

Is this page helpful?

Curl

1
curl -X PATCH https://api.razorpay.com/v1/accounts/acc_LWXFUBYnysbYFV \
2
-u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
3
-H "Content-type: application/json" \
4
-d '{
5
  "legal_business_name": "Acme Corp V2",
6
  "profile": {
7
    "addresses": {
8
      "operation": {
9
        "street1": "5071, Koramangala 6th block",
10
        "street2": "Kormanagala",
11
        "city": "Bengaluru",
12
        "state": "Karnataka",
13
        "postal_code": 560047,
14
        "country": "IN"
15
      }
16
    }
17
  },
18
  "legal_info": {
19
    "pan": "BAACL1234C",
20
    "gst": "10AABCU9603R1ZM"
21
  }
22
}'

Success

Failure

1
{
2
  "id": "acc_LWXFUBYnysbYFV",
3
  "type": "route",
4
  "status": "created",
5
  "email": "gaurava.kumar@example.com",
6
  "profile": {
7
    "category": "healthcare",
8
    "subcategory": "clinic",
9
    "addresses": {
10
      "registered": {
11
        "street1": "507, Koramangala 1st block",
12
        "street2": "MG Road",
13
        "city": "Bengaluru",
14
        "state": "KARNATAKA",
15
        "postal_code": "560034",
16
        "country": "IN"
17
      },
18
      "operation": {
19
        "street1": "5071, Koramangala 6th block",
20
        "street2": "Kormanagala",
21
        "city": "Bengaluru",
22
        "state": "KARNATAKA",
23
        "country": "IN",
24
        "postal_code": 560047
25
      }
26
    }
27
  },
28
  "notes": [],
29
  "created_at": 1679917193,
30
  "phone": "+919000090000",
31
  "contact_name": "Gaurav Kumar",
32
  "reference_id": "124126",
33
  "business_type": "partnership",
34
  "legal_business_name": "Acme Corp V2",
35
  "customer_facing_business_name": "Acme Corp V2",
36
  "legal_info": {
37
    "pan": "BAACL1234C",
38
    "gst": "10AABCU9603R1ZM"
39
  }
40
}
Path Parameters
account_id

*

string

Unique identifier of the Linked Account whose details you need to update.

Request Parameters
phone

*

integer

The Linked Account's business phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name

*

string

The name of the Linked Account's business. For example, Acme Corp. The minimum length is 4 characters and the maximum length is 200.

customer_facing_business_name
string

The Linked Account billing label as it appears on the Razorpay Dashboard. The minimum length is 1 character and the maximum length is 255.

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 Linked Account's account.

Show child parameters (4)

legal_info
object

The legal details about the Linked Account's business. The mandatory

KYC requirement

parameters should be passed depending on the business requirements.

Show child parameters (2)

contact_info
object

Options available for contact support.

Show child parameters (3)

apps
object

The app details of the account holder's business

Show child parameters (3)

Response Parameters
id
string

The unique identifier of the account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.

type
string

The account type. Possible value is route.

status
string

The status of the account. Possible values:

  • created
  • suspended

email
string

The account holder's email address.

phone
integer

The account holder's phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name
string

The name of the account holder's business. For example, Acme Corp. The minimum length is 4 characters and the maximum length is 200.

business_type
string

The type of business operated by the account holder. Possible values:

Business Types

.

profile
object

The account holder's business details.

Show child parameters (3)

legal_info
object

The legal details about the account holder's business. The mandatory

KYC requirement

parameters should be passed depending on the business requirements.

Show child parameters (2)

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.

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

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 Linked Account

PATCH
/v1/accounts/:account_id

Click to copy

Use this endpoint to update a Linked Account details.

You can update all other fields except business_type and email on the created Linked Account.

Is this page helpful?

Path Parameters
account_id

*

string

Unique identifier of the Linked Account whose details you need to update.

Request Parameters
phone

*

integer

The Linked Account's business phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name

*

string

The name of the Linked Account's business. For example, Acme Corp. The minimum length is 4 characters and the maximum length is 200.

customer_facing_business_name
string

The Linked Account billing label as it appears on the Razorpay Dashboard. The minimum length is 1 character and the maximum length is 255.

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 Linked Account's account.

Show child parameters (4)

legal_info
object

The legal details about the Linked Account's business. The mandatory

KYC requirement

parameters should be passed depending on the business requirements.

Show child parameters (2)

contact_info
object

Options available for contact support.

Show child parameters (3)

apps
object

The app details of the account holder's business

Show child parameters (3)

Response Parameters
id
string

The unique identifier of the account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.

type
string

The account type. Possible value is route.

status
string

The status of the account. Possible values:

  • created
  • suspended

email
string

The account holder's email address.

phone
integer

The account holder's phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name
string

The name of the account holder's business. For example, Acme Corp. The minimum length is 4 characters and the maximum length is 200.

business_type
string

The type of business operated by the account holder. Possible values:

Business Types

.

profile
object

The account holder's business details.

Show child parameters (3)

legal_info
object

The legal details about the account holder's business. The mandatory

KYC requirement

parameters should be passed depending on the business requirements.

Show child parameters (2)

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.

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

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

1
curl -X PATCH https://api.razorpay.com/v1/accounts/acc_LWXFUBYnysbYFV \
2
-u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
3
-H "Content-type: application/json" \
4
-d '{
5
  "legal_business_name": "Acme Corp V2",
6
  "profile": {
7
    "addresses": {
8
      "operation": {
9
        "street1": "5071, Koramangala 6th block",
10
        "street2": "Kormanagala",
11
        "city": "Bengaluru",
12
        "state": "Karnataka",
13
        "postal_code": 560047,
14
        "country": "IN"
15
      }
16
    }
17
  },
18
  "legal_info": {
19
    "pan": "BAACL1234C",
20
    "gst": "10AABCU9603R1ZM"
21
  }
22
}'

Success

Failure

1
{
2
  "id": "acc_LWXFUBYnysbYFV",
3
  "type": "route",
4
  "status": "created",
5
  "email": "gaurava.kumar@example.com",
6
  "profile": {
7
    "category": "healthcare",
8
    "subcategory": "clinic",
9
    "addresses": {
10
      "registered": {
11
        "street1": "507, Koramangala 1st block",
12
        "street2": "MG Road",
13
        "city": "Bengaluru",
14
        "state": "KARNATAKA",
15
        "postal_code": "560034",
16
        "country": "IN"
17
      },
18
      "operation": {
19
        "street1": "5071, Koramangala 6th block",
20
        "street2": "Kormanagala",
21
        "city": "Bengaluru",
22
        "state": "KARNATAKA",
23
        "country": "IN",
24
        "postal_code": 560047
25
      }
26
    }
27
  },
28
  "notes": [],
29
  "created_at": 1679917193,
30
  "phone": "+919000090000",
31
  "contact_name": "Gaurav Kumar",
32
  "reference_id": "124126",
33
  "business_type": "partnership",
34
  "legal_business_name": "Acme Corp V2",
35
  "customer_facing_business_name": "Acme Corp V2",
36
  "legal_info": {
37
    "pan": "BAACL1234C",
38
    "gst": "10AABCU9603R1ZM"
39
  }
40
}