Refunding a charge

For refund operations, use the /v1/payments/{paymentId}/refunds endpoint.

Prerequisites

  • The POS is connected to the device using a network or cloud connection
  • The Clover device is in an idle state (that is, no payment is being taken)

Full refund

  1. Construct a request with the required data (fullRefund set to true).
{
  "fullRefund": true
}
  1. Send a POST request to the /v1/payments/{paymentId}/refunds endpoint. Include the payment ID of the original charge in the path.
    Be sure to include the required headers for the request you are making.

The refund is processed for the full amount. After the refund is complete, a success message is returned.

  1. To return to the welcome screen, send a POST request to the /v1/device/welcome endpoint.

Partial refund

If a customer wants to return only part of the original order, you can refund any amount between 0 and the original total.

  1. Construct a request with the minimum required data (the amount to be refunded in cents).
{
  "amount": 2000
}
  1. Send a POST request to the /v1/payments/{paymentId}/refunds endpoint. Include the payment ID of the original charge in the path.

The refund is processed for the specified amount. After the refund is complete, a success message is returned.

  1. To return to the welcome screen, send a POST request to the /device/v1/welcome endpoint.

Did this page help you?