v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Refunds

Create a refund

Initiate a full or partial refund for a captured payment. Use speed=normal (default, 5-7 business days) or speed=optimum for instant refund (falls back to normal if unavailable). Use the X-Refund-Idempotency header with a unique key (>=10 chars) to safely retry without duplicate refunds.

post/payments/{id}/refund

Path parameters

idstring required

Payment ID to refund (pay_*). Payment must be captured.

Request body

amountinteger

Refund amount in paise. Omit to refund the full payment amount.

speed'normal' | 'optimum'

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

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.

Response

Refund initiated.

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.