Create a refund for a payment
Create and process a refund for a specific payment. The refund amount must not exceed the remaining refundable amount.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the payment.
Body
Response
Refund created and processed.
"rf_AbC123XyZ"
ID of the payment being refunded
"pay_Def456UvW"
Current status of the refund
Processing, Succeeded, Failed "Processing"
Amount in smallest currency unit
50000
ISO 4217 currency code
"USD"
Reason for the refund
"Customer request"
Processor transaction ID from the payment processor
"ref_processor_123"
Error code if the refund failed
"unknown_failure"
Human-readable error message if the refund failed
"The refund could not be completed"
Optional metadata as key-value pairs
"2025-10-08T18:20:31Z"
"2025-10-08T18:25:00Z"