Refund
Process full or partial refunds on completed payments. Requires the refunds:write scope.
POST
/api/v1/{system}/refund🔒 refunds:writeRefund a previous payment. Subject to 60-second cooldown and amount validation (cannot exceed remaining balance).
Auth: Bearer JWT
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| referenceId | string | Yes | Original payment reference |
| refundAmount | string | Yes | Decimal amount to refund (must be <= remaining balance) |
| refundReason | string | Yes | Reason for the refund |
| branchId | long | Yes | Branch user ID |
| configId | long | Yes | Terminal config ID |
⚠️ Live testing disabled for this endpoint — it modifies data. Use curl or the SDK against your sandbox.