Issue a credit

Use the /v1/credits endpoint to issue a refund to a customer without tracking the refund against an existing sale or order payment. This transaction type is also known as credit, manual refund, unmatched refund, 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 point of sale (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; there are no running payments.

Steps

1. Send a POST request to the /v1/credits endpoint.
2. Enter the required header parameters for your request.
3. Enter the required body parameters ( amount of the credit in cents) in the request:

{
  "amount": 2450
}

Credit process the requested amount. When the credit is complete, a success message appears.

4. Send a POST request to the /v1/credits/{creditId}/receipt endpoint to print a credit receipt. This step is optional.
5. To return to the welcome screen, send a POST request to the /v1/device/welcome endpoint.