Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
Transfers

Modify settlement hold on a transfer

Put a transfer's settlement on hold or release an existing hold. Use on_hold=true to hold settlement, on_hold=false to release. on_hold_until sets a future timestamp for automatic hold release.

patch/transfers/{id}

Path parameters

idstring required

Transfer ID (trf_*).

Request body

on_holdboolean

true to hold settlement; false to release.

on_hold_untilinteger

Unix timestamp for automatic hold release. null = hold indefinitely until manually released.

Response

Transfer settlement hold updated.

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.