---
title: "Send a credit request to the Clover device"
method: POST
path: "/v1/credits"
tags: ["CREDITS"]
---

# Send a credit request to the Clover device

`POST /v1/credits`

A credit is a refund that is not associated with an existing payment.

## Headers

- `User-Agent` string, required
- `X-Clover-Device-Id` string, required
- `X-POS-Id` string, required
- `X-Clover-Timeout` integer
- `Idempotency-Key` string, required

## Request body

- CreditRequest
  - `amount` integer, required — The amount of the credit, in cents.
  - `deviceOptions` DeviceCreditOptions — Common (applies to payments and credits) device options.
    - `cardEntryMethods` CardEntryMethod[] — The card entry methods/payment options that will be presented to the customer (for example, NFC and MAG_STRIPE).
    - `cardNotPresent` boolean — If true, the secure payments application will skip the CVM entry screen when manual card entry is used. The cardEntryMethods must contain the `MANUAL` value for this flag to be significant. This indicates that the customer was not present to (for example) sign for the transaction.
    - `disableRestartTransactionOnFail` boolean — If the transaction times out or fails because of decline, do not restart it

## Response `200`

A valid CreditResponse

- CreditResponse
  - `credit` Credit
    - `amount` integer
    - `cardTransaction` CardTransaction
      - `cardholderName` string
      - `first6` string, ###### — The first 6 digits
      - `last4` string, #### — The last 4 digits
    - `createdTime` integer — Time payment was recorded on server
    - `device` Reference
      - `id` string — Unique identifier
    - `employee` Reference
      - `id` string — Unique identifier
    - `id` string — Unique identifier
    - `taxAmount` integer — Amount paid in tax

## Other responses

- `209` — Operation was canceled.
- `400` — The request is invalid, and subsequent calls will continue to fail; do not repeat the call.
- `401` — An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.
- `415` — The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format.
- `500` — The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.
- `501` — The device does not have the ability to respond to the requested operation; do not repeat the call.
- `503` — The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation.
- `504` — The Device did not respond in a timely manner. This can be repeated at a later time.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/revisions/08da265101a3/schema)