v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PAYMENTS

Tip adjust a payment

For an unclosed payment, add a tipAmount or update an existing tip. Tips are not additive; the most recent amount is applied at closeout.

post/v1/payments/{paymentId}/tip-adjust

Path parameters

paymentIdstring required

Clover payment UUID

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

tipAmountinteger required

The tip amount, in cents.

Response

A valid TipAdjustResponse

tipAmountinteger

The tip amount, in cents.