Refund a payment

post

https://deviceIpOrHost:12346/connect/v1/payments/{paymentId}/refunds

Returns some or all of a payment amount to the cardholder.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

paymentId

string

required

Clover payment UUID

Body Params

amount

int64

1 to 999999999

The amount to be refunded, in cents, ignored if fullRefund is true.

fullRefund

boolean

Defaults to false

true if a full refund should be performed. If true, amount will be ignored.

Headers

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Id

string

required

The Clover device to route the request to.

X-POS-Id

string

required

An identifier for the POS making the request.

X-Clover-Timeout

integer

0 to 300

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-Key

string

required

The idempotency key transmitted during the request, if any.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A valid RefundResponse

209Operation was canceled.

400The request is invalid, and subsequent calls will continue to fail; do not repeat the call.

401An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.

415The 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.

500The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.

501The device does not have the ability to respond to the requested operation; do not repeat the call.

503The 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.

504The Device did not respond in a timely manner. This can be repeated at a later time.