API | Linked Accounts | Razorpay Docs

You can transfer funds to a vendor by creating a Linked Account using APIs or the

Razorpay Dashboard

Refer to the

Linked Accounts Document

before proceeding with APIs.

You can try out our Linked Account APIs on the Razorpay Postman Public Workspace.

List of Endpoints

API Endpoint	Description
Create a Linked Account	Creates a Linked Account.
Update a Linked Account	Updates a Linked Account.
Fetch a Linked Account	Fetches a Linked Account.
Create a Stakeholder	Creates a Stakeholder.
Update a Stakeholder Account	Updates a Stakeholder account.
Request a Product Configuration	Requests a product configuration.
Update a Product Configuration	Updates a product configuration.
Fetch a Product Configuration	Fetches a product configuration.

Linked Account Entity

The Linked Account entity consists of the following fields.

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

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.

category

string The business category of the account holder. For example, healthcare. Possible values:

Business Category

subcategory

string The business sub-category of the account holder. For example, clinic. Possible values:

Business Sub-Category

addresses

object Details of account holder's address.

registered

object Details of the account holder's registered address.

street1

string Address, line 1. The maximum length is 100 characters.

street2

string Address, line 2. The maximum length is 100 characters.

city

string The city. The maximum length is 100 characters.

state

string The state. The minimum length is 2 and the maximum length is 100.

postal_code

integer The postal code. This should be exactly 6 characters.

country

string The country. The minimum length is 2 and the maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either IN or india.

operation

object Details of the account holder's operational address. This parameter might be required to complete the KYC process. However, it is optional for this API.

street1

string Address, line 1. The maximum length is 100 characters.

street2

string Address, line 2. The maximum length is 100 characters.

city

string The city. The maximum length is 100 characters.

state

string The state. The minimum length is 2 and the maximum length is 100.

postal_code

integer The postal code. This should be exactly 6 characters.

country

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.

pan

string Valid PAN number details of the account holder's business.

This is a 10-digit alphanumeric code. For example, AVOJB1111K.
The 4th digit should be either of 'C', 'H', 'F', 'A', 'T', 'B', 'J', 'G', 'L'.
The regex for Company PAN is /^[a-zA-z]{5}\d{4}[a-zA-Z]{1}$/. This parameter might be required to complete the KYC process. However, it is optional for this API.

gst

string Valid GSTIN number details of the account holder.

This is a 15-digit PAN-based unique identification number.
The Regex to validate GSTIN is /^[0123][0-9][a-z]{5}[0-9]{4}[a-z][0-9][a-z0-9][a-z0-9]$/gi.

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.

chargeback

object The type of contact support.

string The email id of chargeback POC. The maximum length is:

local part (before @): 64 characters.
domain part (after @): 68 characters.
The total character length supported is 132.

phone

integer The phone number of chargeback POC. The maximum length is 10 characters.

policy_url

string The URL of chargeback policy. Regex is (protocol://<domainname>:port/resource path?querystring#fragementid)
protocol-both http/https allowed. Only domain name is mandatory.

refund

object The type of contact support.

string The email id of refund POC. The maximum length is:

local part (before @): 64 characters.
domain part (after @): 68 characters.
The total character length supported is 132.

phone

integer The phone number of refund POC. The maximum length is 10 characters.

policy_url

string The URL of refund policy. Regex is (protocol://<domainname>:port/resource path?querystring#fragementid)
protocol-both http/https allowed.

support

array The type of contact support.

string The email id of support POC. The maximum length is:

local part (before @): 64 characters.
domain part (after @): 68 characters. The total character length supported is 132.

phone

integer The phone number of support POC. The maximum length is 10 characters.

policy_url

string The URL of support policy. Regex is (protocol://<domainname>:port/resource path?querystring#fragementid) protocol-both http/https allowed.

apps

object The app details of the account holder's business

websites

array The website/app for the account holder's business. A minimum of 1 website is required.

android

array Android app details

url

string The link of the Android app. Regex is (protocol://<domainname>:port/resource path?querystring#fragementid) protocol-both http/https allowed.

name

string The name of the Android app.

ios

array iOS app details

url

string The link of the iOS app. Regex is (protocol://<domainname>:port/resource path?querystring#fragementid) protocol-both http/https allowed.

name

string The name of the iOS app.

{
  "id": "acc_GRWKk7qQsLnDjX",
  "type": "route",
  "reference_id": "123123", 
  "status": "created",
  "email": "gauri.kumar@example.org",
  "profile": {
    "category": "healthcare",
    "subcategory": "clinic",
    "addresses": {
      "registered": {
        "street1": "507, Koramangala 1st block",
        "street2": "MG Road",
        "city": "Bengaluru",
        "state": "KARNATAKA",
        "postal_code": 560034,
        "country": "IN"
      },
      "operation": {
        "street1": "507, Koramangala 6th block",
        "street2": "Kormanagala",
        "city": "Bengaluru",
        "state": "KARNATAKA",
        "country": "IN",
        "postal_code": 560047
      }
    },
    "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
  },
  "notes": {
  },
  "created_at": 1611136837,
  "phone": "9999999998",
  "business_type": "partnership",
  "legal_business_name": "Acme Corp",
  "customer_facing_business_name": "Acme Corp",
  "legal_info": {
    "pan": "AAACL1234C",
    "gst": "18AABCU9603R1ZM"
  },
  "apps": {
    "websites": [
      "https://www.example.org"
    ],
    "android": [
      {
        "url": "playstore.example.org",
        "name": "Example"
      }
    ],
    "ios": [
      {
        "url": "appstore.example.org",
        "name": "Example"
      }
    ]
  },
  "brand": {
    "color": "#FFFFFF"
  },
  "contact_name": "Gaurav Kumar",
  "contact_info": {
    "chargeback": {
      "email": "cb@example.org",
      "phone": null,
      "policy_url": null
    },
    "refund": {
      "email": "cb@example.org",
      "phone": null,
      "policy_url": null
    },
    "support": {
      "email": "support@example.org",
      "phone": "9999999998",
      "policy_url": "https://www.google.com"
    }
  }
}

Stakeholders Entity

The Stakeholders entity consists of the following fields.

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 as per the PAN card. The maximum length is 255 characters.

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. The default value is false.

director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone

object The stakeholder's phone number.

primary

integer The primary contact number of the stakeholder. The minimum length is 8 characters and the maximum length is 11.

secondary

integer The secondary contact number of the stakeholder. The minimum length is 8 characters and the maximum length is 11.

addresses

object Details of stakeholder's address.

residential

string Details of the stakeholder's residential address.

street

string The stakeholder's street address. The minimum length is 10 characters and maximum length is 255.

city

string The city. The minimum length is 2 and maximum length is 32.

state

string The state. The minimum length is 2 and maximum length is 32.

postal_code

string The postal code. The minimum length is 2 and maximum length is 10.

country

string The country. The minimum length is 2 and maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either IN or india.

kyc

object The type of document required to establish the stakeholder's identity.

pan

string The PAN of the stakeholder.

This is a 10-digit alphanumeric code. For example, AVOPB1111K.
Regex for Stakeholder PAN: /^[a-zA-z]{5}\d{4}[a-zA-Z]{1}$/
Validation for Stakeholder PAN: The 4th digit should be 'P'. To complete the KYC process, this API parameter might be required, but it is optional for this API.

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

Product Configuration Entity

The Product entity consists of the following fields.

string The unique identifier of a product generated by Razorpay. This id is used to fetch or update a product.

product_name

string The product(s) to be configured. Possible values:

Route

tnc_accepted

object It consists of the configuration for the accepted terms and conditions by the merchant for the requested product. If the terms and conditions are accepted by the user for the requested product, it would consist of following fields:

string The unique identifier representing the acceptance of terms and conditions for a product by a user.

accepted

boolean The flag that represents whether the terms and conditions are accepted by the user.

accepted_at

integer The Unix timestamp at which the terms and conditions were accepted by the user for the requested product.

requested_configuration

object The configuration of the product requested by the user that is yet to be set as active.

active_configuration

object The configuration of the product that has been set as active.

settlements

object The Settlement settings object.

account_number

string The bank account number to which settlements are made. Account details can be found on the Partner's Razorpay Dashboard. For example, 7878780080316316

ifsc_code

string The IFSC associated with the bank account. For example, RATN0VAAPIS.

beneficiary_name

string The name of the beneficiary associated with the bank account. This API parameter is needed complete the KYC process. However, it is optional for this API.

requirements

object The list of requirements to be enabled for this product or some of the configurations under this product.

field_reference

string The field which is in issue or missing. The JSON key path in resolution URL.

resolution_url

string The URL to address the requirement. The API endpoint to be used for updating missing fields or documents.

status

string The status of the requirement.

reason_code

string The reason code for showing in the requirement. Possible values are:

field_missing
needs_clarification
document_missing

string The unique identifier of the account generated by Razorpay. For example, acc_prd_K1eopFF8G21tux. The product is created for this account id.

account_id

string The unique identifier generated by Razorpay. For example, acc_K1em7bWYEiwmnc.

product_name

string The product(s) to be configured. Here it is route.

activation_status

string The status of the product activation.

requested
needs_clarification
under_review
activated
suspended

requested_at

integer The Unix timestamp at which the product configuration has been requested.

{
  "requested_configuration": [],
  "active_configuration": {
    "settlements": {
      "account_number": "1234567890",
      "ifsc_code": "HDFC0000317",
      "beneficiary_name": "Gaurav Kumar"
    }
  },
  "requirements": [
    {
      "field_reference": "settlements.account_number",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code": "field_missing",
      "status": "required"
    },
    {
      "field_reference": "settlements.ifsc",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code": "field_missing",
      "status": "required"
    },
    {
      "field_reference": "kyc.pan",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code": "kyc_failed",
      "status": "required"
    },
    {
      "field_reference": "settlements.beneficiary_name",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code": "field_missing",
      "status": "required"
    }
  ],
  "tnc": {
    "id": "tnc_IgohZaDBHRGjPv",
    "accepted": true,
    "accepted_at": 1641550798
  },
  "id": "acc_prd_HEgNpywUFctQ9e",
  "account_id": "acc_HQVlm3bnPmccC0",
  "product_name": "route",
  "activation_status": "needs_clarification",
  "requested_at": 1605181524
}