> ## Documentation Index
> Fetch the complete documentation index at: https://better-auth-razorpay.amankushwaha.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Transfers

> Create and manage Razorpay Route transfers between linked accounts through the plugin endpoints.

The transfers endpoints use Razorpay Route to move funds from a payment into linked accounts. Route must be enabled on your Razorpay account before you can use these endpoints.

## Create transfer

`POST /api/auth/razorpay/transfer/create`

Creates a transfer from a captured payment to one or more linked accounts.

**Server API name:** `createRazorpayTransfer`\
**Client method:** `authClient.razorpay.transfer.create(...)`

**paymentId** `string` *required*

Razorpay payment id from which to transfer funds.

**transfers** `array` *required*

Array of transfer objects. Each object contains:

**Transfer object**

**account** `string` *required*

Linked account id, for example `acc_XXXX`.

**amount** `integer` *required*

Amount to transfer in subunits.

**currency** `string` *required*

ISO 4217 currency code.

**notes** `object`

Up to 15 key-value pairs, values 256 characters or fewer.

**onHold** `boolean`

Whether the transfer should be held.

**onHoldUntil** `integer`

Unix timestamp until which the transfer is held. Requires `onHold`.

**linkedAccountNotes** `array`

Array of string notes for the linked account.

> [!NOTE]
>
> Errors: `TRANSFER_CREATE_FAILED`.

```ts client.ts theme={null}
const { data, error } = await authClient.razorpay.transfer.create({
  paymentId: "pay_XXXX",
  transfers: [
    {
      account: "acc_YYYY",
      amount: 25000,
      currency: "INR",
      notes: { vendor: "vendor_a" },
    },
  ],
});
```

```ts server.ts theme={null}
const result = await auth.api.createRazorpayTransfer({
  body: {
    paymentId: "pay_XXXX",
    transfers: [
      {
        account: "acc_YYYY",
        amount: 25000,
        currency: "INR",
        notes: { vendor: "vendor_a" },
      },
    ],
  },
  headers: await headers(),
});
```

## Get transfer

`GET /api/auth/razorpay/transfer/get`

Retrieves a single transfer by id.

**Server API name:** `getRazorpayTransfer`\
**Client method:** `authClient.razorpay.transfer.get({ query: { id } })`

**id** `string` *required*

Razorpay transfer id, for example `trf_XXXX`.

> [!NOTE]
>
> Errors: `TRANSFER_FETCH_FAILED`.

```ts client.ts theme={null}
const { data, error } = await authClient.razorpay.transfer.get({
  query: { id: "trf_XXXX" },
});
```

```ts server.ts theme={null}
const result = await auth.api.getRazorpayTransfer({
  query: { id: "trf_XXXX" },
  headers: await headers(),
});
```

## List transfers

`GET /api/auth/razorpay/transfer/list`

Lists transfers with optional filters.

**Server API name:** `listRazorpayTransfers`\
**Client method:** `authClient.razorpay.transfer.list({ query: { ... } })`

**paymentId** `string`

Filter by source payment id.

**limit** `integer`

Maximum number of transfers to return. Maximum value is `100`.

**from** `integer`

Unix timestamp. Return transfers created after this time.

**to** `integer`

Unix timestamp. Return transfers created before this time.

> [!NOTE]
>
> Errors: `TRANSFER_LIST_FAILED`.

```ts client.ts theme={null}
const { data, error } = await authClient.razorpay.transfer.list({
  query: { paymentId: "pay_XXXX", limit: 10 },
});
```

```ts server.ts theme={null}
const result = await auth.api.listRazorpayTransfers({
  query: { paymentId: "pay_XXXX", limit: 10 },
  headers: await headers(),
});
```

## Edit transfer

`POST /api/auth/razorpay/transfer/edit`

Updates the hold status or hold-until date on an existing transfer.

**Server API name:** `editRazorpayTransfer`\
**Client method:** `authClient.razorpay.transfer.edit(...)`

**transferId** `string` *required*

Razorpay transfer id to update.

**onHold** `boolean`

New hold status.

**onHoldUntil** `integer`

New hold-until Unix timestamp. Requires `onHold`.

> [!NOTE]
>
> Errors: `TRANSFER_EDIT_FAILED`.

```ts client.ts theme={null}
const { data, error } = await authClient.razorpay.transfer.edit({
  transferId: "trf_XXXX",
  onHold: true,
  onHoldUntil: 1893456000,
});
```

```ts server.ts theme={null}
const result = await auth.api.editRazorpayTransfer({
  body: {
    transferId: "trf_XXXX",
    onHold: true,
    onHoldUntil: 1893456000,
  },
  headers: await headers(),
});
```

## Reverse transfer

`POST /api/auth/razorpay/transfer/reverse`

Reverses a transfer, returning the funds to the source payment.

**Server API name:** `reverseRazorpayTransfer`\
**Client method:** `authClient.razorpay.transfer.reverse(...)`

**transferId** `string` *required*

Razorpay transfer id to reverse.

**amount** `integer`

Amount to reverse in subunits. Omit to reverse the full transfer amount.

> [!NOTE]
>
> Errors: `TRANSFER_REVERSE_FAILED`.

```ts client.ts theme={null}
const { data, error } = await authClient.razorpay.transfer.reverse({
  transferId: "trf_XXXX",
  amount: 10000,
});
```

```ts server.ts theme={null}
const result = await auth.api.reverseRazorpayTransfer({
  body: {
    transferId: "trf_XXXX",
    amount: 10000,
  },
  headers: await headers(),
});
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.