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

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

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

Fetch With Id

API Test Keys

Fetch a Linked Account With ID

GET
/v2/accounts/:account_id

Click to copy

Use this endpoint to fetch details of a Linked Account using the unique identifier.

Is this page helpful?

Curl

1
curl -X GET 'https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \

Success

Failure

1
{
2
   "id":"acc_GLGeLkU2JUeyDZ",
3
   "type":"route",
4
   "reference_id":"123123",
5
   "status":"created",
6
   "email":"gaurav.kumar@example.org",
7
   "profile":{
8
      "category":"healthcare",
9
      "subcategory":"clinic",
10
      "addresses":{
11
         "registered":{
12
            "street1":"507, Koramangala 1st block",
13
            "street2":"MG Road",
14
            "city":"Bengaluru",
15
            "state":"KARNATAKA",
16
            "postal_code":560034,
17
            "country":"IN"
18
         },
19
         "operation":{
20
            "street1":"507, Koramangala 6th block",
21
            "street2":"Kormanagala",
22
            "city":"Bengaluru",
23
            "state":"KARNATAKA",
24
            "country":"IN",
25
         }
26
      },
27
      "business_model":null
28
   },
29
   "notes":[
30
      
31
   ],
32
   "created_at":1611136837,
33
   "phone":"9999999998",
34
   "business_type":"partnership",
35
   "legal_business_name":"Acme Corp",
36
   "customer_facing_business_name":"Acme Corp",
37
   "legal_info":{
38
      "pan":"AAACL1234C",
39
      "gst":"18AABCU9603R1ZM"
40
   },
41
   "apps":{
42
      "websites":[
43
         
44
      ],
45
      "android":[
46
         {
47
            "url":null,
48
            "name":null
49
         }
50
      ],
51
      "ios":[
52
         {
53
            "url":null,
54
            "name":null
55
         }
56
      ]
57
   },
58
   "brand":{
59
      "color":null
60
   },
61
   "contact_name":"Gaurav Kumar",
62
   "contact_info":{
63
      "chargeback":{
64
         "email":null,
65
         "phone":null,
66
         "policy_url":null
67
      },
68
      "refund":{
69
         "email":null,
70
         "phone":null,
71
         "policy_url":null
72
      },
73
      "support":{
74
         "email":null,
75
         "phone":null,
76
         "policy_url":null
77
      }
78
   }
79
}
Path Parameters
account_id
string

The unique identifier of the Linked Account. For example, acc_GLGeLkU2JUeyDZ.

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.

reference_id
string

The internal reference id. This value can be maximum of 20 characters. For example, 123123.

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)

business_model
string

The business description. The minimum length is 1 character and the maximum length is 255.

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.

Show child parameters (3)

apps
object

The app details of the account holder's business

Show child parameters (3)

Errors

The id provided does not exist

Error Status: 400

This error occurs when the Linked Account does not belong to the requested merchant, or it is invalid.

Solution

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

Fetch a Linked Account With ID

GET
/v2/accounts/:account_id

Click to copy

Use this endpoint to fetch details of a Linked Account using the unique identifier.

Is this page helpful?

Path Parameters
account_id
string

The unique identifier of the Linked Account. For example, acc_GLGeLkU2JUeyDZ.

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.

reference_id
string

The internal reference id. This value can be maximum of 20 characters. For example, 123123.

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)

business_model
string

The business description. The minimum length is 1 character and the maximum length is 255.

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.

Show child parameters (3)

apps
object

The app details of the account holder's business

Show child parameters (3)

Errors

The id provided does not exist

Error Status: 400

This error occurs when the Linked Account does not belong to the requested merchant, or it is invalid.

Solution

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

Curl

1
curl -X GET 'https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \

Success

Failure

1
{
2
   "id":"acc_GLGeLkU2JUeyDZ",
3
   "type":"route",
4
   "reference_id":"123123",
5
   "status":"created",
6
   "email":"gaurav.kumar@example.org",
7
   "profile":{
8
      "category":"healthcare",
9
      "subcategory":"clinic",
10
      "addresses":{
11
         "registered":{
12
            "street1":"507, Koramangala 1st block",
13
            "street2":"MG Road",
14
            "city":"Bengaluru",
15
            "state":"KARNATAKA",
16
            "postal_code":560034,
17
            "country":"IN"
18
         },
19
         "operation":{
20
            "street1":"507, Koramangala 6th block",
21
            "street2":"Kormanagala",
22
            "city":"Bengaluru",
23
            "state":"KARNATAKA",
24
            "country":"IN",
25
         }
26
      },
27
      "business_model":null
28
   },
29
   "notes":[
30
      
31
   ],
32
   "created_at":1611136837,
33
   "phone":"9999999998",
34
   "business_type":"partnership",
35
   "legal_business_name":"Acme Corp",
36
   "customer_facing_business_name":"Acme Corp",
37
   "legal_info":{
38
      "pan":"AAACL1234C",
39
      "gst":"18AABCU9603R1ZM"
40
   },
41
   "apps":{
42
      "websites":[
43
         
44
      ],
45
      "android":[
46
         {
47
            "url":null,
48
            "name":null
49
         }
50
      ],
51
      "ios":[
52
         {
53
            "url":null,
54
            "name":null
55
         }
56
      ]
57
   },
58
   "brand":{
59
      "color":null
60
   },
61
   "contact_name":"Gaurav Kumar",
62
   "contact_info":{
63
      "chargeback":{
64
         "email":null,
65
         "phone":null,
66
         "policy_url":null
67
      },
68
      "refund":{
69
         "email":null,
70
         "phone":null,
71
         "policy_url":null
72
      },
73
      "support":{
74
         "email":null,
75
         "phone":null,
76
         "policy_url":null
77
      }
78
   }
79
}