Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
CREDITS

Refund a payment

Returns some or all of a payment amount to the cardholder.

post/v1/payments/{paymentId}/refunds

Path parameters

paymentIdstring required

Clover payment UUID

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Idempotency-Keystring required

The idempotency key transmitted during the request, if any.

Request body

amountinteger

The amount to be refunded, in cents, ignored if fullRefund is true.

fullRefundboolean

true if a full refund should be performed. If true, amount will be ignored.

Response

A valid RefundResponse

paymentIdstring

A Clover payment UUID

Example response

{
  "refund": {
    "cardTransaction": {
      "last4": "1234"
    }
  },
  "payment": {
    "cardTransaction": {
      "last4": "1234"
    },
    "refunds": [
      {
        "cardTransaction": {
          "last4": "1234"
        }
      }
    ]
  }
}