Issue a credit
United States
Canada
Europe
If a merchant needs to refund a customer without tracking the refund against an existing payment, the /v1/credits
endpoint method is used. This type of transaction is also referred to as a manual or naked refund. Credits can be for any amount
, and the request must include an Idempotency-Key
to maintain a record of the credit between the POS and the Clover system. See Track transactions with idempotency keys for more information.
Prerequisites
- POS is connected to the device using a network or cloud connection.
- Clover device is idle; that is, no payment is being taken.
Steps
- Construct a request with the required data—the
amount
of the credit in cents.
{
"amount": 2450
}
- Send a POST request to the
/v1/credits
endpoint. - Required. Include the required headers for your request.
The credit is processed for the requested amount. After the credit is complete, a success message appears.

- Optional. To print a credit receipt, send a POST request to the
/v1/credits/{creditId}/receipt
endpoint. - To return to the welcome screen, send a POST request to the
/v1/device/welcome
endpoint.
Updated about 1 month ago