Route APIs - Razorpay

Available in🇮🇳 India

You can use the Route APIs to perform various actions. You can perform all of these actions from the Dashboard as well.

API-wise Integration Checklist for Route

Ensure the currency is in INR when creating an order_id.
Ensure orders created have the partial_payment parameter set to false. Transfers will only occur if the orders are paid and the payments move to the captured state.
Ensure to pass the Linked Account id while creating an order.
Ensure the amount passed in the transfers object is not greater than the order amount.
If the amount passed in the transfers object is less than the main amount, the balance will automatically move to the Razorpay nodal account.

Example:

Amount Type	Amount INRSGDMYR
Base amount	10,0001000
Amount in `transfers` object	7,500750
Balance amount (Automatically added to the main Razorpay nodal account)	2,500250

Once the payment has been successfully made, verify the Payment Signature at your backend.
You can use Fetch Transfer for an Order API for reconciliation.
You can also subscribe to Webhooks and set up the transfer.processed Webhook event.

Use Fetch a Payment by ID API to confirm the payment status before running the Transfers API.
Ensure the payment is in the captured state.
Ensure the amount does not exceed the initial payment amount.
Ensure the amount you want to transfer to a Linked Account is less than the initial amount.

Watch Out!You must subtract fees and tax to calculate the amount allowed to be transferred.

Ensure the nodal account has sufficient balance for the amount to be transferred.
Ensure the amount that needs to be transferred is correct as there is no maker-checker facility after creating the transfer.
Ensure the currency is in INR.

List of Transfers APIs

The table below provides the list of various Transfers APIs and their brief description:

API	Description
Create Transfers from Orders	API to create Transfers from the received Orders
Create Transfers from Payments	API to create Transfers to linked accounts once the payments are captured.
Direct Transfers	API to transfer funds directly from your account balance to the linked accounts
Fetch Transfers for a Payment	API to fetch transfers created for a specific payment
Fetch Transfer for an Order	API to fetch transfers created for a specific Order ID
Fetch a Transfer	API to view specific transfer details
Fetch Transfers for a Settlement	API to retrieve the collection of transfers created for a particular Settlement ID
Fetch Settlement Details	API to view the details of settlements made to linked accounts
Fetch Payments of a Linked Account	API to view all the payments received by a linked account
Refund Payments and Reverse Transfer from a Linked Account	API to initiate a payment refund to a customer
Reverse a Transfer	API to initiate a reversal of funds from the linked account to your account
API to modify Settlement Hold for Transfers	API to modify the settlement configuration for a particular `transfer_id`

List of Linked Account APIs

The table below provides the list of various Linked Account APIs and their brief description:

API	Description
Create a Linked Account	API to create a Linked Account.
Update Linked Accounts	API to update Linked Accounts.
Fetch a Linked Account	API to retrieve details of a Linked Account.
Create a Stakeholder	API to create a Stakeholder account.
Update a Stakeholder Account	API to update a Stakeholder account.
Request a Product Configuration	API to request a product configuration.
Update a Product Configuration	API to update a product configuration.
Fetch a Product Configuration	API to fetch a product configuration.