Introduction

API Reference Guide

API Changelog

Understand Razorpay APIs

Authentication

Sandbox Setup

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Subscriptions

Route

Smart Collect

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates

Complaints

UPI Number

UPI Lite

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Fetch Balance

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Route

Request Product Config

API Test Keys

Request a Product Configuration

POST
/v2/accounts/:account_id/products

Click to copy

Use this endpoint to request a product configuration.

Is this page helpful?

Path Parameters
account_id
string

The unique identifier of the account generated by Razorpay. For example, acc_HQVlm3bnPmccC0. This id is used to fetch or update a product. The product is created for this account id.

Request Parameters
product_name

*

string

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

tnc_accepted
boolean

Determines whether the terms and conditions are accepted or not. Possible values:

  • true: Terms and conditions are accepted.
  • false: Terms and conditions are not accepted.

Response Parameters
id
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:

Show child parameters (3)

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.

Show child parameters (1)

requirements
object

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

Show child parameters (4)

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

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.

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

The product requested is invalid.

Error Status: 400

This error occurs when the provided data is invalid.

Solution

The selected tnc accepted is invalid.

Error Status: 400

This error occurs when the tnc.accepted value is false.

Solution

Request a Product Configuration

POST
/v2/accounts/:account_id/products

Click to copy

Use this endpoint to request a product configuration.

Is this page helpful?

Path Parameters
account_id
string

The unique identifier of the account generated by Razorpay. For example, acc_HQVlm3bnPmccC0. This id is used to fetch or update a product. The product is created for this account id.

Request Parameters
product_name

*

string

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

tnc_accepted
boolean

Determines whether the terms and conditions are accepted or not. Possible values:

  • true: Terms and conditions are accepted.
  • false: Terms and conditions are not accepted.

Response Parameters
id
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:

Show child parameters (3)

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.

Show child parameters (1)

requirements
object

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

Show child parameters (4)

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

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.

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

The product requested is invalid.

Error Status: 400

This error occurs when the provided data is invalid.

Solution

The selected tnc accepted is invalid.

Error Status: 400

This error occurs when the tnc.accepted value is false.

Solution