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

Fetch A Transfer

API Test Keys

Fetch a Transfer With ID

GET
/v1/transfers/:id

Click to copy

Use this endpoint to fetch details of a transfer by its unique identifier.

Is this page helpful?

Curl

change language

change language

1
curl -X GET https://api.razorpay.com/v1/transfers/trf_JJD536GI6wuz3m \
2
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \

Success

Failure

1
{
2
  "id": "trf_JJD536GI6wuz3m",
3
  "entity": "transfer",
4
  "status": "processed",
5
  "source": "pay_JGmCgTEa9OTQcX",
6
  "recipient": "acc_IRQWUleX4BqvYn",
7
  "amount": 300,
8
  "currency": "INR",
9
  "amount_reversed": 0,
10
  "fees": 1,
11
  "tax": 0,
12
  "notes": {
13
    "name": "Saurav Kumar",
14
    "roll_no": "IEC2011026"
15
  },
16
  "linked_account_notes": [
17
    "roll_no"
18
  ],
19
  "on_hold": false,
20
  "on_hold_until": null,
21
  "settlement_status": "pending",
22
  "recipient_settlement_id": null,
23
  "created_at": 1649933574,
24
  "processed_at": 1649933579,
25
  "error": {
26
    "code": null,
27
    "description": null,
28
    "reason": null,
29
    "field": null,
30
    "step": null,
31
    "id": "trf_JJD536GI6wuz3m",
32
    "source": null,
33
    "metadata": null
34
  }
35
}
Path Parameters
id

*

string

Unique identifier of the transfer for which details must be fetched.

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

transfer_id is not a valid id

Error Status: 400

This error occurs when you pass an invalid transfer_id in the API endpoint.

Solution

Fetch a Transfer With ID

GET
/v1/transfers/:id

Click to copy

Use this endpoint to fetch details of a transfer by its unique identifier.

Is this page helpful?

Path Parameters
id

*

string

Unique identifier of the transfer for which details must be fetched.

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

transfer_id is not a valid id

Error Status: 400

This error occurs when you pass an invalid transfer_id in the API endpoint.

Solution

Curl

change language

change language

1
curl -X GET https://api.razorpay.com/v1/transfers/trf_JJD536GI6wuz3m \
2
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \

Success

Failure

1
{
2
  "id": "trf_JJD536GI6wuz3m",
3
  "entity": "transfer",
4
  "status": "processed",
5
  "source": "pay_JGmCgTEa9OTQcX",
6
  "recipient": "acc_IRQWUleX4BqvYn",
7
  "amount": 300,
8
  "currency": "INR",
9
  "amount_reversed": 0,
10
  "fees": 1,
11
  "tax": 0,
12
  "notes": {
13
    "name": "Saurav Kumar",
14
    "roll_no": "IEC2011026"
15
  },
16
  "linked_account_notes": [
17
    "roll_no"
18
  ],
19
  "on_hold": false,
20
  "on_hold_until": null,
21
  "settlement_status": "pending",
22
  "recipient_settlement_id": null,
23
  "created_at": 1649933574,
24
  "processed_at": 1649933579,
25
  "error": {
26
    "code": null,
27
    "description": null,
28
    "reason": null,
29
    "field": null,
30
    "step": null,
31
    "id": "trf_JJD536GI6wuz3m",
32
    "source": null,
33
    "metadata": null
34
  }
35
}