Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
Transfers

Create a direct transfer

Create an on-demand direct transfer from the merchant account to a Linked Account. Requires the Direct Transfer feature to be enabled on the account. Supports idempotency via the X-Transfer-Idempotency header (unique to direct transfers).

post/transfers

Headers

X-Transfer-Idempotencystring

Idempotency key for direct transfers. If provided, retrying with the same key within 24 hours returns the original transfer instead of creating a duplicate.

Request body

accountstring required

Linked Account ID (acc_*).

amountinteger required

Amount in paise. Minimum 10000 (₹100).

currency'INR' required
notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

linked_account_notesstring[]
on_holdboolean
on_hold_untilinteger

Response

Transfer created.

idstring

Transfer ID. Prefix: trf_

entity'transfer'
sourcestring

Source entity ID (payment ID, order ID, or merchant account ID for direct transfers).

recipientstring

Destination Linked Account ID (acc_*).

amountinteger

Transfer amount in paise. Minimum 10000 (₹100).

currency'INR'

Always INR for transfers.

amount_reversedinteger

Total amount reversed so far in paise.

feesinteger

Transfer fee charged in paise.

taxinteger

GST on transfer fee in paise.

transfer_status'created' | 'pending' | 'processed' | 'failed' | 'reversed' | 'partially_reversed'

Transfer processing status.

settlement_status'pending' | 'on_hold' | 'settled'

Settlement status of the transferred funds in the Linked Account.

on_holdboolean

If true, settlement of this transfer is on hold.

on_hold_untilinteger

Unix timestamp until which settlement is on hold. null means indefinite hold.

recipient_settlement_idstring

Settlement ID (setl_*) in the Linked Account once settled.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

linked_account_notesstring[]

Keys from notes that will be visible to the Linked Account in their dashboard.

created_atinteger
processed_atinteger

Unix timestamp when the transfer was processed.