Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Transfers

Direct Transfers Idempotent Request

API Test Keys

Create a Direct Transfer (Idempotent Request)

POST
/v1/transfers

Click to copy

Idempotency allows you to safely retry or send the same request multiple times without fear of repeating the transfer request more than once.

  • When you try to create a transfer, in some cases due to network downtimes, you may not get a response from our servers. As a consequence, you will not be aware of the transfer id or its state. In such cases, you can safely retry the transaction using the same idempotency key without risk of double-payout or duplication.

  • To make a transfer request idempotent, add the header X-Transfer-Idempotency to the request and pass an idempotency key against it. The idempotency key (4-36 characters) can contain alphabets, numbers, hyphens, underscores and space only. For example, fbdabb70-9548-4cfe-8da1-c9bbf39e96b0.

Watch Out!

Currently, idempotency is supported only on the Direct Transfers API.

Handy Tips

  • When retrying a request, the request body must be the same as the first request for idempotency to work. A different payload will be rejected as a BAD_REQUEST.
  • The idempotency key in retries must be the same as the original request.
  • Use unique idempotency keys for each unique request.
  • If we receive another request while the first one is in process, we will send a 409 error code. You can retry if you get this error code.

Is this page helpful?

Curl

change language

change language

1
curl -X POST https://api.razorpay.com/v1/transfers \
2
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
3
-H 'content-type: application/json' \
4
-H 'X-Transfer-Idempotency: fbdabb70-9548-4cfe-8da1-c9bbf39e96b0' \
5
-d '{
6
  "account": "acc_CPRsN1LkFccllA",
7
  "amount": 100,
8
  "currency": "INR"
9
}'

Success

Failure

1
{
2
  "id": "trf_JqpKevElHShZkw",
3
  "entity": "transfer",
4
  "status": "processed",
5
  "source": "acc_CJoeHMNpi0nC7k",
6
  "recipient": "acc_CPRsN1LkFccllA",
7
  "amount": 100,
8
  "currency": "INR",
9
  "amount_reversed": 0,
10
  "fees": 1,
11
  "tax": 0,
12
  "notes": [],
13
  "linked_account_notes": [],
14
  "on_hold": false,
15
  "on_hold_until": null,
16
  "recipient_settlement_id": null,
17
  "created_at": 1657273505,
18
  "processed_at": 1657273505,
19
  "error": {
20
    "code": null,
21
    "description": null,
22
    "reason": null,
23
    "field": null,
24
    "step": null,
25
    "id": "trf_JqpKevElHShZkw",
26
    "source": null,
27
    "metadata": null
28
  }
29
}
Request Parameters
account

*

string

Unique identifier of the Linked Account to which the transfer must be made.

amount

*

integer

The amount (in paise) to be transferred to the Linked Account. For example, for an amount of ₹200.35, the value of this field should be 20035.

currency

*

string

The currency used in the transaction. We support only INR for Route transactions.

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

Response Parameters
id
string

Unique identifier of the transfer.

entity
string

The name of the entity. Here, it is transfer.

transfer_status
string

The status of the transfer. Possible values are:

  • created
  • pending
  • processed
  • failed
  • reversed
  • partially_reversed

settlement_status
string

The status of the settlement. Possible values are:

  • pending
  • on_hold
  • settled

source
string

Unique identifier of the transfer source. The source can be a payment or an order.

recipient
string

Unique identifier of the transfer destination, that is, the Linked Account.

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

currency
string

ISO currency code. We support route transfers only in INR.

amount_reversed
integer

Amount reversed from this transfer for refunds.

notes
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".

error
string

Provides error details that may occur during transfers.

Show child parameters (7)

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

on_hold
boolean

Indicates whether the account settlement for transfer is on hold. Possible values:

  • 1: Puts the settlement on hold.
  • 0: Releases the settlement.

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

recipient_settlement_id
string

Unique identifier of the settlement.

created_at
integer

Timestamp, in Unix, at which the record was created.

Errors

The API key/secret provided is invalid.

Error Status: 4xx

This 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

Create a Direct Transfer (Idempotent Request)

POST
/v1/transfers

Click to copy

Idempotency allows you to safely retry or send the same request multiple times without fear of repeating the transfer request more than once.

  • When you try to create a transfer, in some cases due to network downtimes, you may not get a response from our servers. As a consequence, you will not be aware of the transfer id or its state. In such cases, you can safely retry the transaction using the same idempotency key without risk of double-payout or duplication.

  • To make a transfer request idempotent, add the header X-Transfer-Idempotency to the request and pass an idempotency key against it. The idempotency key (4-36 characters) can contain alphabets, numbers, hyphens, underscores and space only. For example, fbdabb70-9548-4cfe-8da1-c9bbf39e96b0.

Watch Out!

Currently, idempotency is supported only on the Direct Transfers API.

Handy Tips

  • When retrying a request, the request body must be the same as the first request for idempotency to work. A different payload will be rejected as a BAD_REQUEST.
  • The idempotency key in retries must be the same as the original request.
  • Use unique idempotency keys for each unique request.
  • If we receive another request while the first one is in process, we will send a 409 error code. You can retry if you get this error code.

Is this page helpful?

Request Parameters
account

*

string

Unique identifier of the Linked Account to which the transfer must be made.

amount

*

integer

The amount (in paise) to be transferred to the Linked Account. For example, for an amount of ₹200.35, the value of this field should be 20035.

currency

*

string

The currency used in the transaction. We support only INR for Route transactions.

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

Response Parameters
id
string

Unique identifier of the transfer.

entity
string

The name of the entity. Here, it is transfer.

transfer_status
string

The status of the transfer. Possible values are:

  • created
  • pending
  • processed
  • failed
  • reversed
  • partially_reversed

settlement_status
string

The status of the settlement. Possible values are:

  • pending
  • on_hold
  • settled

source
string

Unique identifier of the transfer source. The source can be a payment or an order.

recipient
string

Unique identifier of the transfer destination, that is, the Linked Account.

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

currency
string

ISO currency code. We support route transfers only in INR.

amount_reversed
integer

Amount reversed from this transfer for refunds.

notes
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".

error
string

Provides error details that may occur during transfers.

Show child parameters (7)

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

on_hold
boolean

Indicates whether the account settlement for transfer is on hold. Possible values:

  • 1: Puts the settlement on hold.
  • 0: Releases the settlement.

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

recipient_settlement_id
string

Unique identifier of the settlement.

created_at
integer

Timestamp, in Unix, at which the record was created.

Errors

The API key/secret provided is invalid.

Error Status: 4xx

This 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

Curl

change language

change language

1
curl -X POST https://api.razorpay.com/v1/transfers \
2
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
3
-H 'content-type: application/json' \
4
-H 'X-Transfer-Idempotency: fbdabb70-9548-4cfe-8da1-c9bbf39e96b0' \
5
-d '{
6
  "account": "acc_CPRsN1LkFccllA",
7
  "amount": 100,
8
  "currency": "INR"
9
}'

Success

Failure

1
{
2
  "id": "trf_JqpKevElHShZkw",
3
  "entity": "transfer",
4
  "status": "processed",
5
  "source": "acc_CJoeHMNpi0nC7k",
6
  "recipient": "acc_CPRsN1LkFccllA",
7
  "amount": 100,
8
  "currency": "INR",
9
  "amount_reversed": 0,
10
  "fees": 1,
11
  "tax": 0,
12
  "notes": [],
13
  "linked_account_notes": [],
14
  "on_hold": false,
15
  "on_hold_until": null,
16
  "recipient_settlement_id": null,
17
  "created_at": 1657273505,
18
  "processed_at": 1657273505,
19
  "error": {
20
    "code": null,
21
    "description": null,
22
    "reason": null,
23
    "field": null,
24
    "step": null,
25
    "id": "trf_JqpKevElHShZkw",
26
    "source": null,
27
    "metadata": null
28
  }
29
}