## Transfers
### Create transfers from payment
```js
instance.payments.transfer(paymentId,{
"transfers": [
{
"account": 'acc_HgzcrXeSLfNP9U',
"amount": 100,
"currency": "INR",
"notes": {
"name": "Gaurav Kumar",
"roll_no": "IEC2011025"
},
"linked_account_notes": [
"branch"
],
"on_hold": 1,
"on_hold_until": 1671222870
}
]
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment to be fetched |
| transfers | object | All parameters listed [here](https://razorpay.com/docs/api/route/#create-transfers-from-payments) are supported |
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "trf_Jhf4Ak94xAcyeS",
"entity": "transfer",
"status": "pending",
"source": "pay_I7watngocuEY4P",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 100,
"currency": "INR",
"amount_reversed": 0,
"notes": {
"name": "Gaurav Kumar",
"roll_no": "IEC2011025"
},
"linked_account_notes": [
"roll_no"
],
"on_hold": true,
"on_hold_until": 1671222870,
"recipient_settlement_id": null,
"created_at": 1655272292,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_Jhf4Ak94xAcyeS",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Create transfers from order
```js
instance.orders.create({
"amount": 2000,
"currency": "INR",
"transfers": [
{
"account": "acc_CPRsN1LkFccllA",
"amount": 1000,
"currency": "INR",
"notes": {
"branch": "Acme Corp Bangalore North",
"name": "Gaurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": true,
"on_hold_until": 1671222870
},
{
"account": "acc_CNo3jSI8OkFJJJ",
"amount": 1000,
"currency": "INR",
"notes": {
"branch": "Acme Corp Bangalore South",
"name": "Saurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": true
}
]
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| amount* | integer | The transaction amount, in paise |
| currency* | string | The currency of the payment (defaults to INR) |
| receipt | string | A unique identifier provided by you for your internal reference. |
| transfers | array | All parameters listed [here](https://razorpay.com/docs/api/route/#create-transfers-from-orders) are supported |
**Response:**
```json
{
"id": "order_Jhf1Sn06my7AUb",
"entity": "order",
"amount": 2000,
"amount_paid": 0,
"amount_due": 2000,
"currency": "INR",
"receipt": null,
"offer_id": "offer_JGQvQtvJmVDRIA",
"offers": [
"offer_JGQvQtvJmVDRIA"
],
"status": "created",
"attempts": 0,
"notes": [],
"created_at": 1655272138,
"transfers": [
{
"id": "trf_Jhf1SpAYVIeRoP",
"entity": "transfer",
"status": "created",
"source": "order_Jhf1Sn06my7AUb",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 1000,
"currency": "INR",
"amount_reversed": 0,
"notes": {
"branch": "Acme Corp Bangalore North",
"name": "Gaurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": true,
"on_hold_until": 1671222870,
"recipient_settlement_id": null,
"created_at": 1655272138,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_Jhf1SpAYVIeRoP",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Direct transfers
```js
instance.transfers.create({
"account": accountId,
"amount": 500,
"currency": "INR"
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| accountId* | string | The id of the account to be fetched |
| amount* | integer | The amount to be captured (should be equal to the authorized amount, in paise) |
| currency* | string | The currency of the payment (defaults to INR) |
**Response:**
```json
{
"id": "trf_JhdmwXgQpEk38N",
"entity": "transfer",
"status": "processed",
"source": "acc_HZbJUcl6DBDLIN",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 100,
"currency": "INR",
"amount_reversed": 0,
"fees": 1,
"tax": 0,
"notes": [],
"linked_account_notes": [],
"on_hold": false,
"on_hold_until": null,
"recipient_settlement_id": null,
"created_at": 1655267791,
"processed_at": 1655267792,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_JhdmwXgQpEk38N",
"source": null,
"metadata": null
}
}
```
-------------------------------------------------------------------------------------------------------
### Fetch transfer for a payment
```js
instance.payments.fetchTransfer(paymentId)
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment to be fetched |
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "trf_JGQjgcy8zHFq7e",
"entity": "transfer",
"status": "partially_reversed",
"source": "order_JGQjgaUikLJo8n",
"recipient": "acc_HalyQGZh9ZyiGg",
"amount": 500,
"currency": "INR",
"amount_reversed": 100,
"fees": 1,
"tax": 0,
"notes": {
"branch": "Acme Corp Bangalore South",
"name": "Saurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": true,
"on_hold_until": 1679691505,
"settlement_status": "on_hold",
"recipient_settlement_id": null,
"created_at": 1649326643,
"processed_at": 1649326701,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_JGQjgcy8zHFq7e",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Fetch transfer for an order
```js
instance.orders.fetchTransferOrder(orderId)
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| orderId* | string | The id of the order to be fetched |
**Response:**
```json
{
"id": "order_JfOO8JYmAtYRL0",
"entity": "order",
"amount": 2000,
"amount_paid": 0,
"amount_due": 2000,
"currency": "INR",
"receipt": null,
"offer_id": "offer_JGQvQtvJmVDRIA",
"offers": [
"offer_JGQvQtvJmVDRIA"
],
"status": "created",
"attempts": 0,
"notes": [],
"created_at": 1654776878,
"transfers": {
"entity": "collection",
"count": 2,
"items": [
{
"id": "trf_JfOO8LGAPdwky4",
"entity": "transfer",
"status": "created",
"source": "order_JfOO8JYmAtYRL0",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 1000,
"currency": "INR",
"amount_reversed": 0,
"fees": 0,
"tax": null,
"notes": {
"branch": "Acme Corp Bangalore North",
"name": "Gaurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": true,
"on_hold_until": 1671222870,
"settlement_status": null,
"recipient_settlement_id": null,
"created_at": 1654776878,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_JfOO8LGAPdwky4",
"source": null,
"metadata": null
}
},
{
"id": "trf_JfOO8M4p6tQZ6g",
"entity": "transfer",
"status": "created",
"source": "order_JfOO8JYmAtYRL0",
"recipient": "acc_HalyQGZh9ZyiGg",
"amount": 1000,
"currency": "INR",
"amount_reversed": 0,
"fees": 0,
"tax": null,
"notes": {
"branch": "Acme Corp Bangalore South",
"name": "Saurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": false,
"on_hold_until": null,
"settlement_status": null,
"recipient_settlement_id": null,
"created_at": 1654776878,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_JfOO8M4p6tQZ6g",
"source": null,
"metadata": null
}
}
]
}
}
```
-------------------------------------------------------------------------------------------------------
### Fetch transfer
```js
instance.transfers.fetch(transferId)
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| transferId* | string | The id of the transfer to be fetched |
**Response:**
```json
{
"id": "trf_IJOI2DHWQYwqU3",
"entity": "transfer",
"status": "created",
"source": "order_IJOI2CD6CNIywP",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 100,
"currency": "INR",
"amount_reversed": 0,
"fees": 0,
"tax": null,
"notes": {
"branch": "Acme Corp Bangalore North",
"name": "Gaurav Kumar"
},
"linked_account_notes": [
"branch"
],
"on_hold": true,
"on_hold_until": 1671222870,
"settlement_status": null,
"recipient_settlement_id": null,
"created_at": 1636435963,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_IJOI2DHWQYwqU3",
"source": null,
"metadata": null
}
}
```
-------------------------------------------------------------------------------------------------------
### Fetch transfers for a settlement
```js
instance.transfers.all({
"recipient_settlement_id": recipientSettlementId
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| recipientSettlementId* | string | The recipient settlement id obtained from the settlement.processed webhook payload. |
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "trf_HWjmkReRGPhguR",
"entity": "transfer",
"status": "processed",
"source": "pay_HWjY9DZSMsbm5E",
"recipient": "acc_HWjl1kqobJzf4i",
"amount": 1000,
"currency": "INR",
"amount_reversed": 0,
"fees": 3,
"tax": 0,
"notes": [],
"linked_account_notes": [],
"on_hold": false,
"on_hold_until": null,
"settlement_status": "settled",
"recipient_settlement_id": "setl_HYIIk3H0J4PYdX",
"created_at": 1625812996,
"processed_at": 1625812996,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_HWjmkReRGPhguR",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Fetch settlement details
```js
instance.transfers.fetchSettlements()
```
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "trf_JhdmwXgQpEk38N",
"entity": "transfer",
"status": "processed",
"source": "acc_HZbJUcl6DBDLIN",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 100,
"currency": "INR",
"amount_reversed": 0,
"fees": 1,
"tax": 0,
"notes": [],
"linked_account_notes": [],
"on_hold": false,
"on_hold_until": null,
"settlement_status": null,
"recipient_settlement_id": null,
"recipient_settlement": null,
"created_at": 1655267791,
"processed_at": 1655267792,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_JhdmwXgQpEk38N",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Refund payments and reverse transfer from a linked account
```js
instance.payments.refund(paymentId,{
"amount" : 100,
"reverse_all" : true
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment to be fetched |
| amount* | integer | The amount to be captured (should be equal to the authorized amount, in paise) |
| reverse_all | boolean | Reverses transfer made to a linked account. Possible values:
* `true` - Reverses transfer made to a linked account.
* `false` - Does not reverse transfer made to a linked account.|
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "pay_JHAe1Zat55GbZB",
"entity": "payment",
"amount": 5000,
"currency": "INR",
"status": "captured",
"order_id": "order_IluGWxBm9U8zJ8",
"invoice_id": null,
"international": false,
"method": "netbanking",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "Test Transaction",
"card_id": null,
"bank": "KKBK",
"wallet": null,
"vpa": null,
"email": "gaurav.kumar@example.com",
"contact": "+919999999999",
"notes": {
"address": "Razorpay Corporate Office"
},
"fee": 118,
"tax": 18,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"bank_transaction_id": "7003347"
},
"created_at": 1649488316
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Fetch payments of a linked account
```js
var instance = new Razorpay({
key_id: key,
key_secret: secret,
headers: {"X-Razorpay-Account": "acc_IRQWUleX4BqvYn"}
});
instance.payments.all()
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| X-Razorpay-Account | string | The linked account id to fetch the payments received by linked account |
**Response:**
```json
{
"entity": "collection",
"count": 2,
"items": [
{
"id": "pay_E9uth3WhYbh9QV",
"entity": "payment",
"amount": 100,
"currency": "INR",
"status": "captured",
"order_id": null,
"invoice_id": null,
"international": null,
"method": "transfer",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": null,
"card_id": null,
"bank": null,
"wallet": null,
"vpa": null,
"email": "",
"contact": null,
"notes": [],
"fee": 0,
"tax": 0,
"error_code": null,
"error_description": null,
"created_at": 1580219046
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Reverse transfers from all linked accounts
```js
instance.transfers.reverse(transferId,{
"amount":100
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| transferId* | string | The id of the transfer to be fetched |
| amount | integer | The amount to be captured (should be equal to the authorized amount, in paise) |
**Response:**
```json
{
"id": "rfnd_JJFNlNXPHY640A",
"entity": "refund",
"amount": 100,
"currency": "INR",
"payment_id": "pay_JJCqynf4fQS0N1",
"notes": [],
"receipt": null,
"acquirer_data": {
"arn": null
},
"created_at": 1649941680,
"batch_id": null,
"status": "processed",
"speed_processed": "normal",
"speed_requested": "normal"
}
```
-------------------------------------------------------------------------------------------------------
### Hold settlements for transfers
```js
instance.payments.transfer(paymentId,{
"transfers": [
{
"amount": 100,
"account": "acc_I0QRP7PpvaHhpB",
"currency": "INR",
"on_hold": 1
}
]
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment to be fetched |
| transfers | array | All parameters listed [here](https://razorpay.com/docs/api/route/#hold-settlements-for-transfers) are supported |
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "trf_Jfm1KCF6w1oWgy",
"entity": "transfer",
"status": "pending",
"source": "pay_JXPULbHbkkkS8D",
"recipient": "acc_I0QRP7PpvaHhpB",
"amount": 100,
"currency": "INR",
"amount_reversed": 0,
"notes": [],
"linked_account_notes": [],
"on_hold": true,
"on_hold_until": null,
"recipient_settlement_id": null,
"created_at": 1654860101,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_Jfm1KCF6w1oWgy",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Modify settlement hold for transfers
```js
instance.transfers.edit(transferId,{
"on_hold": true,
"on_hold_until": "1679691505"
})
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| transferId* | string | The id of the payment to be fetched |
| on_hold* | boolean | Possible values is `true` or `false` |
| on_hold_until | integer | Timestamp, in Unix, that indicates until when the settlement of the transfer must be put on hold |
**Response:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "trf_JhemwjNekar9Za",
"entity": "transfer",
"status": "pending",
"source": "pay_I7watngocuEY4P",
"recipient": "acc_HjVXbtpSCIxENR",
"amount": 100,
"currency": "INR",
"amount_reversed": 0,
"notes": [],
"linked_account_notes": [],
"on_hold": true,
"on_hold_until": null,
"recipient_settlement_id": null,
"created_at": 1655271313,
"processed_at": null,
"error": {
"code": null,
"description": null,
"reason": null,
"field": null,
"step": null,
"id": "trf_JhemwjNekar9Za",
"source": null,
"metadata": null
}
}
]
}
```
-------------------------------------------------------------------------------------------------------
**PN: * indicates mandatory fields**
**For reference click [here](https://razorpay.com/docs/api/route/#transfers/)**