Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
Refunds

Update a refund

Update the notes field of a refund. Only notes can be modified.

patch/refunds/{id}

Path parameters

idstring required

Refund ID (rfnd_*).

Request body

notesNotes required

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

Response

Updated refund.

idstring

Unique refund identifier. Prefix: rfnd_

entity'refund'
amountinteger

Refund amount in paise.

currencystring
payment_idstring

The original payment ID (pay_*).

notesNotes

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

receiptstring

Your internal reference identifier.

created_atinteger
batch_idstring

Set if refund was part of a batch upload.

status'pending' | 'processed' | 'failed'

pending: being processed. processed: credited to customer. failed: refund failed.

speed_requested'normal' | 'optimum'

normal: 5-7 business days. optimum: instant if available, falls back to normal.

speed_processed'instant' | 'normal'

Actual processing mode used.