Skip to main content
POST
Available in🇮🇳 India🇲🇾 Malaysia🇸🇬 Singapore🇺🇸 United States
Use this endpoint to create Transfers from captured payments. You can create and capture payments in the regular payments flow using the Razorpay Curlec Checkout and Payment APIs. You should perform additional steps to disburse payments using Razorpay Curlec Route.
  1. The customer pays the amount using the standard payment flow.
  2. Once the payment is captured, you can initiate a transfer to Linked Accounts with a transfer API call. You have to pass the details such as account_id and amount.

​
Path Parameters

​
string
required
Unique identifier of the payment on which the transfer must be created.

​
Request Parameters

​
array
Details regarding the transfer.
​
string
required
Unique identifier of the Linked Account to which the transfer is to be made.
​
integer
required
The amount to be transferred to the Linked Account. For example, for an amount of ₹200.35, the value of this field should be 20035.
​
string
required
The currency in which the transfer should be made. We support only INR for Route transactions.
​
json object
Set of key-value pairs that can be associated with an entity. These pairs can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported. For example, "region": "south", "city": "Bangalore".
​
array
List of keys from the notes object which needs to be shown to Linked Accounts on their Dashboard. For example, "region", "city". Only the keys will be shown, not values.
​
boolean
Indicates whether the account settlement for transfer is on hold. Know more about on hold settlements. Possible values:
  • true: Puts the settlement on hold.
  • false: Releases the settlement.
​
integer
Timestamp, in Unix, that indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely. We recommend you set the on_hold_until value greater than 30 mins from the transfer creation time.
Handy Tips
  • The settlement schedule defined for the Linked Account takes precedence over the on_hold and on_hold_until functionality. This means that a defined settlement schedule is the minimum time required for the transfer to be settled.
  • Let us take the example of a T+10 settlement schedule:
    • If you create a transfer with on_hold: true and then release it on T+7 day, the settlement will only go out on T+10 day.
    • If you create a transfer with on_hold: true and on_hold_until: 1491567400 (assume the timestamp 1491567400 corresponds to 7 days after transfer), the on_hold will change to false on T+7 day. The settlement will only go out on T+10 day.

​
Response Parameters

​
string
Unique identifier of the transfer.
​
string
The name of the entity. Here, it is transfer.
​
string
The status of the transfer. Possible values are:
  • created
  • pending
  • processed
  • failed
  • reversed
  • partially_reversed
​
string
The status of the settlement. Possible values are:
  • pending
  • on_hold
  • settled
​
string
Unique identifier of the transfer source. The source can be a payment or an order.
​
string
Unique identifier of the transfer destination, that is, the Linked Account.
​
integer
The amount to be transferred to the Linked Account, in paise. For example, for an amount of ₹200.35, the value of this field should be 20035.
​
string
ISO currency code. We support route transfers only in INR.
​
integer
Amount reversed from this transfer for refunds.
​
json object
Set of key-value pairs that can be associated with an entity. These pairs can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported. For example, "region": "south", "city": "Bangalore".
​
string
Provides error details that may occur during transfers.
​
string
Type of the error.
​
string
Error description.
​
string
Name of the parameter in the API request that caused the error.
​
string
The point of failure in the specific operation. For example, customer, business and so on.
​
string
The stage where the transaction failure occurred. Stages can be different depending on the payment method used to make the transaction.
​
string
Unique identifier of the transfer.
​
string
The exact error reason. It can be handled programmatically.
​
array
List of keys from the notes object which needs to be shown to Linked Accounts on their Dashboard. For example, "region", "city". Only the keys will be shown, not values.
​
boolean
Indicates whether the account settlement for transfer is on hold. Possible values:
  • true: Puts the settlement on hold.
  • false: Releases the settlement.
​
integer
Timestamp, in Unix format, indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely.
​
string
Unique identifier of the settlement.
​
integer
Timestamp, in Unix, at which the record was created.

​
Errors

Code: 4xxThis error occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the Dashboard.Solution: Make sure the API Keys are active and entered correctly. Also, there should not be any whitespaces before or after the keys.
Code: 400This error occurs when the amount is less than the minimum amount. The transaction amount expressed in the currency subunit, such as paise (in INR) should always be greater than or equal to 100.Solution: Make sure the amount is equal to or greater than the minimum amount of ₹100.
Code: 400This error occurs when a mandatory field is empty.Solution: Make sure to fill in all the mandatory fields.
Code: 400This error occurs when you pass an invalid payment_id in the API endpoint.Solution: Make sure to pass a vaild payment_id.
Code: 400This error occurs when there is a miss-match between the API keys via which the transaction was initiated for that particular payment_id and the API keys passed in the API call.Solution: Ensure the API keys via which you have accepted the payment for the payment_id passed in the API endpoint matches the API keys passed in the API call.
Code: 400This error occurs when the account_code passed is invalid or does not belong to the requested merchant.Solution: Make sure to pass the valid account_code.
Code: 400This error occurs when the total balance is less than or equal to the transfer amount.Solution: Make sure you have enough balance. You can also add funds to the account and then try doing the transfer.
Code: 400This error occurs when the total transferred amount exceeds the captured payment amount.Solution: Make sure the transfer amount is less than the captured payment.