Issue a full or partial refund against a captured payment. Accepts transactionId, amount, currency, and optional reason. Returns the refund record.
Use this endpoint to issue a full or partial refund against a previously captured payment. Refunds are processed through the same upstream provider that handled the original transaction, so processing times and availability depend on that provider. For partial refunds, pass an amount less than the original payment; for a full refund, pass the original payment amount exactly.
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.
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.
Current status of the refund. The initial value is "created". Status transitions are delivered via webhook as the upstream provider processes the refund.