Route APIs

List of Route APIs available to perform various actions.


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

API-wise Integration Checklist for Route๐Ÿ”—

Create Transfers from Orders๐Ÿ”—

  • Ensure the currency is in INR when creating an order ID.
  • Ensure orders created have the partial_payment parameter set to 0. 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:
    Base amount = โ‚น10,000
    Amount in transfers object = โ‚น7,500
    Balance amount = โ‚น2,500 will be automatically added to the main Razorpay nodal account.
  • 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.

Create Transfers from Payments๐Ÿ”—

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

Direct Transfers๐Ÿ”—

  • 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 Route APIs๐Ÿ”—

The table below provides the list of various Route 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

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 Transfers from all Linked Accounts

API to initiate a reversal of funds from the linked account to your account

Hold Settlements For Transfers

API to hold the transfer settlement for an indefinite time or until a defined time

Modify Settlement Hold for Transfers

modify the settlement configuration for a particular transfer_id

ร—