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?

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.

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.

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