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

as well.

  • 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 at your backend.
  • You can use API for reconciliation.
  • You can also and set up the transfer.processed Webhook event.

  • Use

    API to confirm the payment status before running the 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.

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

APIDescription
API to create Transfers from the received Orders
API to create Transfers to linked accounts once the payments are captured.
API to transfer funds directly from your account balance to the linked accounts
API to fetch transfers created for a specific payment
API to fetch transfers created for a specific Order ID
API to view specific transfer details
API to retrieve the collection of transfers created for a particular Settlement ID
API to view the details of settlements made to linked accounts
API to view all the payments received by a linked account
API to initiate a payment refund to a customer
API to initiate a reversal of funds from the linked account to your account
modify the settlement configuration for a particular transfer_id

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

APIDescription
API to create a Linked Account.
API to update Linked Accounts.
API to retrieve details of a Linked Account.
API to create a Stakeholder account.
API to update a Stakeholder account.
API to request a product configuration.
API to update a product configuration.
API to fetch a product configuration.

Was this page helpful?