Use the
Idempotency-Key header on every refund request. If a request fails or times out, retrying with the same key guarantees you will not issue a duplicate refund.Headers
Your secret API key. Keep this value server-side and never expose it in client code.
A unique string you generate per refund attempt. Reuse the same key to safely retry a failed request without creating a duplicate refund.
Must be
application/json.Body
UUID of the original captured payment you want to refund.
Refund amount as a decimal string (for example,
"10.00"). Must not exceed the original payment amount. To issue a full refund, pass the exact original payment amount.Three-letter ISO 4217 currency code. Must match the currency of the original payment. The value is automatically uppercased before processing.
Human-readable reason for the refund. Maximum 500 characters. Stored on the refund record and forwarded to the upstream provider where supported.