Skip to main content
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(...)
string
required
Razorpay payment id from which to transfer funds.
array
required
Array of transfer objects. Each object contains:
Errors: TRANSFER_CREATE_FAILED.

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 } })
string
required
Razorpay transfer id, for example trf_XXXX.
Errors: TRANSFER_FETCH_FAILED.

List transfers

GET /api/auth/razorpay/transfer/list Lists transfers with optional filters. Server API name: listRazorpayTransfers
Client method: authClient.razorpay.transfer.list({ query: { ... } })
string
Filter by source payment id.
integer
Maximum number of transfers to return. Maximum value is 100.
integer
Unix timestamp. Return transfers created after this time.
integer
Unix timestamp. Return transfers created before this time.
Errors: TRANSFER_LIST_FAILED.

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(...)
string
required
Razorpay transfer id to update.
boolean
New hold status.
integer
New hold-until Unix timestamp. Requires onHold.
Errors: TRANSFER_EDIT_FAILED.

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(...)
string
required
Razorpay transfer id to reverse.
integer
Amount to reverse in subunits. Omit to reverse the full transfer amount.
Errors: TRANSFER_REVERSE_FAILED.