Update a Linked Account
PATCH/v2/accounts/:account_idClick 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 *
stringUnique identifier of the Linked Account whose details you need to update.
Request Parameters
phone*
integerThe 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 stringThe Linked Account billing label as it appears on the Dashboard. The minimum length is 1 character and the maximum length is 255.
reference_id stringPartner's external account reference id. The minimum length is 1 character and the maximum length is 512.
profile *
objectThe business details of the Linked Account's account.
Show child parameters (4)
legal_info objectThe legal details about the Linked Account's business. The mandatory
parameters should be passed depending on the business requirements.contact_info objectOptions available for contact support.
Show child parameters (3)
apps objectThe app details of the account holder's business
Show child parameters (3)
Response Parameters
idstring The unique identifier of the account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.
typestring The account type. Possible value is route.
statusstringThe status of the account. Possible values:
createdsuspended
emailstringThe account holder's email address.
phoneintegerThe account holder's phone number. The minimum length is 8 characters and the maximum length is 15.
legal_business_namestring 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_typestringThe type of business operated by the account holder. Possible values:
.profileobjectThe account holder's business details.
Show child parameters (3)
legal_infoobjectThe legal details about the account holder's business. The mandatory
parameters should be passed depending on the business requirements.notesobjectContains user-defined fields stored by the partner for reference purposes.
contact_namestringThe name of the contact. The minimum length is 4 and the maximum length is 255 characters.
contact_infoobjectOptions 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/v2/accounts/:account_idClick 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 *
stringUnique identifier of the Linked Account whose details you need to update.
Request Parameters
phone*
integerThe 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 stringThe Linked Account billing label as it appears on the Dashboard. The minimum length is 1 character and the maximum length is 255.
reference_id stringPartner's external account reference id. The minimum length is 1 character and the maximum length is 512.
profile *
objectThe business details of the Linked Account's account.
Show child parameters (4)
legal_info objectThe legal details about the Linked Account's business. The mandatory
parameters should be passed depending on the business requirements.contact_info objectOptions available for contact support.
Show child parameters (3)
apps objectThe app details of the account holder's business
Show child parameters (3)
Response Parameters
idstring The unique identifier of the account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.
typestring The account type. Possible value is route.
statusstringThe status of the account. Possible values:
createdsuspended
emailstringThe account holder's email address.
phoneintegerThe account holder's phone number. The minimum length is 8 characters and the maximum length is 15.
legal_business_namestring 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_typestringThe type of business operated by the account holder. Possible values:
.profileobjectThe account holder's business details.
Show child parameters (3)
legal_infoobjectThe legal details about the account holder's business. The mandatory
parameters should be passed depending on the business requirements.notesobjectContains user-defined fields stored by the partner for reference purposes.
contact_namestringThe name of the contact. The minimum length is 4 and the maximum length is 255 characters.
contact_infoobjectOptions 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