v1
latestOpenAPI 3.0.12026-07-242871595.3 MBCREDITS
Send a credit request to the Clover device
A credit is a refund that is not associated with an existing payment.
post/v1/credits
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
Response
A valid CreditResponse
Example response
{
"credit": {
"cardTransaction": {
"last4": "1234"
}
}
}